node.js - TypeScript 类型根据其他参数缩小回调中函数参数的范围

Question

我正在处理经典的 Node 回调。示例:

myFunction('foo', (err: Error|null, data?: Buffer) =>{
  if (err) {
    // typeof err is Error
    // typeof data is Buffer|undefined
  } else {
    // typeof err is null;
    // typeof data is Buffer|undefined;
  }
});

我正在尝试定义自己的回调接受函数myFunction。我正在努力实现两件事:

1. 我希望能够根据 err 的类型推断 data 的类型
2. 我希望能够隐式推断输入参数的类型

示例:

// types of err and data are inferred from readFile
readFile('foo', (err, data) => {
  if (err) {
    // typeof err is Error
    // typeof data is undefined
  } else {
    // typeof err is null
    // typeof data is Buffer
  }
}

有什么方法可以在当前的 typescript 中实现其中任何一个吗？

Answer 1

按照惯例，您会使用 discriminated union 的单个参数type 而不是两个联合类型参数，例如 err 和 data，它们的类型彼此相关。

TypeScript 对于相关表达式确实没有太多支持；请参阅microsoft/TypeScript#30581 。也就是说，没有一个很好的方法来告诉编译器，而 err 的类型是 Error | null 且 data 的类型为 Buffer |未定义，err和data类型的某些组合是不可能的。您可以使用control flow analysis检查 err 的类型，但它不会影响 data 的感知类型...编译器错误地假设它们是独立的表达式。

这是我能得到的最接近的；它大量使用 tuples in rest and spread expressions你真的必须与编译器斗争才能让它发生:

declare function myFunction(
  someString: string,
  someCallback: (...args: [Error, undefined] | [null, Buffer]) => void
): void;

someCallback 的类型是一个只有两个参数的函数，这两个参数要么是类型 [Error, undefined] 要么是类型化的 [null, Buffer] 。现在您可以使用两个参数回调来调用它，但是您将遇到与已经遇到的完全相同的问题:检查 err 不会对 执行任何操作数据:

// can't call it this way
myFunction("oops", (err, data) => {
  err; // Error | null
  data; // Buffer | undefined
  if (err) {
    data; // still Buffer | undefined 😟
  }
});

相反，您还必须在回调实现中使用剩余参数:

myFunction("foo", (...errData) => {
  if (errData[0]) {
    const [err, data] = errData;
    err; // Error
    data; // undefined
  } else {
    const [err, data] = errData;
    err; // null
    data; // Buffer
  }
});

这是可行的，因为当您检查 errData[0] 时，您正在检查元组对象的单个属性，并且编译器将使用控制流分析将 errData 缩小为两种已知类型之一。您只能在检查之后将 errData 分解为 err 和 data。

---

我强烈建议您考虑在回调中切换到单个可区分的联合参数。看看这个解决方案是多么简单:

type Param = { type: "Error"; err: Error } | { type: "Data"; data: Buffer };

declare function myFunction(
  someString: string,
  someCallback: (param: Param) => void
): void;

myFunction("foo", param => {
  if (param.type === "Error") {
    param.err; // Error
  } else {
    param.data; // Buffer
  }
});

这正是您想要的，无需战斗。

---

Link to code