是否可以在 Typescript 中定义非空数组类型？

Question

我有一个我知道永远不会为空的数字列表。是否可以在 Typescript 中定义一个从不为空的数组？

我知道像 [ number, number ] 这样的元组是可能的，但这不起作用，因为我的数组可以是任何大小。

我猜我要找的是NonEmptyArray<number> 类型。

它存在吗？ :)

Answer 1

允许您仅检查 array.length > 0 以防范空数组的功能请求 microsoft/TypeScript#38000 因过于复杂而被拒绝。本质上，您通常不能简单地在 TypeScript 中检查 length 以使编译器相信给定数字键的属性的可用性。

你可以像这样定义一个非空数组类型：

type NonEmptyArray<T> = [T, ...T[]];

const okay: NonEmptyArray<number> = [1, 2];
const alsoOkay: NonEmptyArray<number> = [1];
const err: NonEmptyArray<number> = []; // error!

这是由于在 TS 3.0 中添加了对 rest elements in tuple types 的支持。我不确定你的用例是什么......不过，使用这种类型可能比你想象的更烦人：

function needNonEmpty(arr: NonEmptyArray<number>) {}
function needEmpty(arr: []) {}

declare const bar: number[];
needNonEmpty(bar); // error, as expected

if (bar.length > 0) {
    needNonEmpty(bar); // ugh, still error!
}

如果你想让length 检查起作用，你需要使用类似用户定义的类型保护函数，但使用起来还是很烦人：

function isNonEmptyArray<T>(arr: T[]): arr is NonEmptyArray<T> {
    return arr.length > 0;
}

if (isNonEmptyArray(bar)) {
    needNonEmpty(bar); // okay
} else {
    needEmpty(bar); // error!! urgh, do you care?        
} 

无论如何希望这会有所帮助。祝你好运！

Answer 2

我也对此感到疑惑，并想出了一个不同的解决方案：

type NonEmptyArray<T> = T[] & { 0: T };