整数（文字）联合类型，以 NaN 作为有效返回值

Question

我有一个联合返回类型的（比较）函数。它可以返回-1、1 或0。但是，我需要一个特殊情况（“结果”），用于当至少一个被比较的项目没有定义时。编译器允许我添加 null 作为潜在的返回值，但不能添加 NaN（在某些情况下这会有意义，例如比较数字或日期）。

这样编译

function myFunc(item1: MyType, item2: MyType): -1 | 0 | 1 | null {
   ...
}

但是对于这个，编译器说“找不到名称 NaN”：

function myFunc(item1: MyType, item2: MyType): -1 | 0 | 1 | NaN {
   ...
}

为什么不允许NaN？有没有办法使用NaN？

Answer 1

与1 不同，NaN 不能用作literal type（即只包含该字面值的类型）。

const n1 = 1, n2 = NaN;
typeof n1; // 1
typeof n2; // number

我们也可以使用number 作为返回类型，但这将允许更多返回值，例如-2。如果你想限制选项，null 对我来说很好。

Answer 2

NaN 本身不是类型，而是const 类型的Number 值。所以没有办法将任何东西定义为 NaN 类型。

这是有道理的，因为数字的文字类型都是单个值，例如-1，或文字值 1 | 0 | -1 的并集，但 NaN 不是单个值，因为没有 NaN 可以与任何其他值进行比较，它实际上是一组无限的值。

我建议使用NaN 来指示函数的特定结果是一个坏主意，因为您可以测试获得该结果的唯一方法是调用另一个函数。最好将 null 或 undefined 添加到返回类型（或者如果您不喜欢这样，那么文字字符串如何）。

请记住：

let foo = NaN;
switch(foo) {
    case 1: console.log('got 1'); break
    case NaN: console.log('got NaN'); break;
    default: console.log('other');
}

将输出“其他”。

所以你可以这样做：

function myFunc(item1: MyType, item2: MyType): -1 | 0 | 1 | 'not comparable' {
   ...
}

然后您可以将结果与“不可比较”进行比较。