键入数组类型的保护

时间:2018-04-13 09:18:17

标签: arrays typescript types

对非数组类型使用typeof类型保护非常简单(例如来自docs):

function padLeft(value: string, padding: string | number) {
    if (typeof padding === "number") {
        return Array(padding + 1).join(" ") + value;
    }
    if (typeof padding === "string") {
        return padding + value;
    }
    throw new Error(`Expected string or number, got '${padding}'.`);
}

然而,当涉及到数组类型时,它变得更加复杂。 我假设以下代码可以工作:

function join(array: number[] | string[]): string {
    if (typeof array[0] === 'number') {
        return foo(array);
    } else {
        return bar(array)
    }
}

function foo(n: number[]): string {
    return n.join();
}

function bar(s: string[]): string {
    return s.join();
}

对我来说似乎很简单:期望的类型是数字数组或字符串数​​组 如果数组中第一个元素的类型为number,则该数组的类型为number[]。否则,这是一个字符串数组。

不幸的是,TypeScript编译器并不聪明,我收到编译错误:

  

类型'数字[] |的参数串[]'不能分配给参数   类型'字符串[]'

如何让它发挥作用?

2 个答案:

答案 0 :(得分:5)

答案是用户定义类型警卫

您可以定义自己的类型保护,以确定数组是否为数字数组:

function isNumbers(array: number[] | string[]): array is number[] {
    return typeof array[0] === 'number'
}

详细了解用户定义的类型防护here

以下是您的代码的工作示例:

function join(array: number[] | string[]): string {
    if (isNumbers(array)) {
        return foo(array);
    } else {
        return bar(array)
    }
}

function foo(n: number[]): string {
    return n.join();
}

function bar(s: string[]): string {
    return s.join();
}

function isNumbers(array: number[] | string[]): array is number[] {
    return typeof array[0] === 'number'
}

TypeScript playground example

答案 1 :(得分:1)

JeB 的回答对我来说是一个非常好的开始,但我需要一些更强大的东西,因为我必须处理任意输入。这是我想出的:

function isNumberArray(value : unknown) : value is number[] {
    if (!Array.isArray(value)) {
        return false;
    }

    if (value.some((v) => typeof v !== "number")) {
        return false;
    }

    return true;
}