使用条件返回类型实现泛型函数

Question

我正在尝试一个非常基本的（人为的）条件类型函数并遇到意外错误：

function test<
  T
>(
  maybeNumber: T
): T extends number ? number : string {
  if (typeof maybeNumber === 'number') {
    return maybeNumber // Type 'T & number' is not assignable to type 'T extends number ? number : string'.
  }

  return 'Not a number' // Type '"Not a number"' is not assignable to type 'T extends number ? number : string'.
}

我认为这是条件类型的一种非常简单的用法，所以不确定发生了什么。有什么想法吗？

澄清一下，我并没有真正尝试实现这个特定的功能。我只是在试验条件类型，想更好地理解为什么这实际上不起作用。

Answer 1

正确答案和当前解决方法（在撰写本文时）：

type MaybeNumberType<T extends number | string> = T extends number
  ? number
  : string;

function test<T extends number | string>(
  maybeNumber: T,
): MaybeNumberType<T> {
  if (typeof maybeNumber === 'number') {
    return <MaybeNumberType<T>>(<unknown>maybeNumber);
  }

  return <MaybeNumberType<T>>(<unknown>'Not a number');
}

test(3); // 3
test('s'); // Not a number

Answer 2

问题是maybeNumber 在运行时可以是一个数字，即使T 没有扩展number。在这种情况下，您的函数返回一个number，但它的类型声明说它应该返回string。考虑：

function test_the_test(value: Object) {
    // no type error here, even though test(value) will return a number at runtime
    let s: string = test(value);
}

test_the_test(23);

在这种情况下，T = Object 不会扩展 number - 它是超类型，而不是子类型 - 所以条件类型 T extends number ? number : string 解析为 string。我们可以用一个泛型类型来测试它：

type Test<T> = T extends number ? number : string
type TestObject = Test<Object>
// TestObject is string

所以，您的函数test 实际上至少在它声称将返回一个字符串的情况下返回一个数字。这意味着该函数不是类型安全的，出现类型错误是正确的。

事实上，给定这些类型注释，您的函数没有明智的、类型安全的实现。 test<number>(23) 应该返回 number，但 test<Object>(23) 应该返回 string；但是两者都编译为相同的 Javascript，因此无法在运行时知道函数应该返回哪种类型。满足这两个约束的唯一方法是编写一个永不返回的函数（例如，通过无条件抛出异常）；如果您从不返回值，则返回值永远不会有错误的类型。所以你的功能需要重新设计。

---

在 Typescript 中有两种明智的方法来编写一个检查输入是否为数字的函数。一种是编写user-defined type guard，如果它返回true，则将其参数的类型缩小为number：

function isNumber(x: any): x is number {
    return typeof x === 'number';
}

另一种方法是编写一个assertion function，如果它不是数字则抛出错误，从而将其参数的类型缩小到number：

function assertNumber(x: any): asserts x is number {
    if(typeof x !== 'number') {
        throw new TypeError('Not a number');
    }
}

不幸的是，当输入不是数字时，这些都不会返回字符串。但两者都可能适合您的实际用例。

Answer 3

根本问题是 TypeScript 的编译器没有通过控制流分析来缩小泛型类型变量的类型。检查(typeof maybeNumber === "number")时，编译器可以将值maybeNumber缩小为number，但不会将类型参数T缩小为number .因此它无法验证将number 值分配给返回类型T extends number ? number : string 是否安全。编译器必须执行一些它目前不执行的分析，例如“好吧，如果typeof maybeNumber === "number"，我们仅从maybeNumber 的类型推断T，那么在这个块内我们可以将T 缩小到number，因此我们应该返回一个 number extends number ? number : string 类型的值，也就是 number"。但这不会发生。

对于具有条件返回类型的泛型函数来说，这是一个相当大的痛点。与此相关的规范开放 GitHub 问题可能是 microsoft/TypeScript#33912，但还有许多其他 GitHub 问题，这是主要问题。

这就是“为什么这不起作用”的答案？

---

如果您对重构不感兴趣，可以忽略其余部分，但知道在这种情况下该怎么做而不是等待语言更改可能仍然具有指导意义。

这里维护您的调用签名的最直接的解决方法是使您的函数成为单个签名overload，其中实现签名不是通用的。这实质上放松了实现内部的类型安全保证：

type MyConditional<T> = T extends number ? number : string;
type Unknown = string | number | boolean | {} | null | undefined;

function test<T>(maybeNumber: T): MyConditional<T>;
function test(maybeNumber: Unknown): MyConditional<Unknown> {
  if (typeof maybeNumber === 'number') {
    const ret: MyConditional<typeof maybeNumber> = maybeNumber;
    return ret;
  }
  const ret: MyConditional<typeof maybeNumber> = "Not a number";
  return ret;
}

在这里，我已经尽我所能通过使用注释为 MyConditional<typeof maybeNumber> 的临时 ret 变量来保证类型安全，该变量使用控制流分析缩小类型 maybeNumber .如果您切换检查，这至少会抱怨（将=== 转换为!== 以进行验证）。但通常我只是做一些像这样更简单的事情，然后让筹码落在他们可能的地方：

function test2<T>(maybeNumber: T): MyConditional<T>;
function test2(maybeNumber: any): string | number {
  if (typeof maybeNumber === 'number') {
    return maybeNumber;
  }
  return "Not a number";
}

好的，希望对您有所帮助；祝你好运！

Playground link to code

Answer 4

如果用重载实现你的函数会更好：

function test(arg: number): number;
function test(arg: unknown): string;
function test(arg: any): string | number {
  if (typeof arg === 'number') {
    return arg;
  }

  return 'Not a number'
}

Answer 5

我相信你在错误的地方定义了返回类型：

function test<T extends number | String>(maybeNumber: T) {
if (typeof maybeNumber === 'number') {
  return maybeNumber
}
return 'Not a number'

}