typescript - 通过返回类型的调用签名联合缩小函数类型

Question

我正在尝试制作一种基本上是调用签名重载的类型，但基于返回类型而不是参数。

type Callback<T> = (value: T) => void

type CallbackHandler<TResult> = (event: object, cb: Callback<TResult>) => void
type AsyncHandler<TResult> = (event: object) => Promise<TResult>

type Handler<TResult> = CallbackHandler<TResult> | AsyncHandler<TResult>

const cbHandler: Handler<number> = (e1, cb1) => {
  // this works
  cb1(1)
}
cbHandler({}, () => {})

const asyncHandler: Handler<number> = async (e2) => {
  // here e2 is implicitly typed as `any`
  // it shouldn't because the function returns Promise<number>, not void
  return 1
}
asyncHandler({}) // this should be callable with 1 argument

Playground Link

这有可能吗？或者也许这应该作为 TS 错误/功能请求提交？

Answer 1

这里的问题是 functions with fewer parameters are assignable to functions with more parameters , 和 functions returning non- void are assignable to functions returning void .这些都是有用且类型安全的有意行为，但它们有时会令人惊讶并产生令人沮丧的后果。

这意味着以下分配是有效的:

const f = (event: object) => Promise.resolve(3);
const c: CallbackHandler<number> = f; // okay
const a: AsyncHandler<number> = f; // okay

因此当编译器查看时:

const asyncHandler: Handler<number> = async (e2) => { return 1 }
// we'll ignore this error until later ----> ~~

它看到 asyncHandler可分配给 CallbackHandler<number>和 AsyncHandler<number>并且不会缩小它。这意味着以下错误符合预期:

asyncHandler({}) // error

如果你想避免这种情况，你应该只注释 asyncHandler作为AsyncHandler<number> :

const asyncHandler: AsyncHandler<number> = async (e2) => { return 1 }
asyncHandler({}) // okay

---

当然，这并不能说明为什么有一个隐含的 any在 e2 上参数。

如果您实现函数类型的联合，您需要接受它们参数的联合(请注意，这是双重情况，当您尝试调用函数类型的联合时，您需要传入参数的交集，support for which was implemented in TypeScript 3.3)。但不是编译器 contextually typing回调参数是这样一个联合(在你的情况下是 object | object 或只是 object)，编译器只是放弃上下文类型并回退到 any .

即使您更改了定义以便确实发生缩小(而不是 void 返回，放一些不兼容的东西)，您仍然会遇到相同的错误:

const stillAProblem: ((x: string) => number) | ((x: string, y: number) => string) =
  x => 3; // error! implicit any

stillAProblem("").toFixed(); // okay

这似乎是 TypeScript 的设计限制或错误。

microsoft/TypeScript#6357早在 2016 年就说“函数联合不会给你上下文输入”，就好像这是生活中的事实，当时可能就是这样。从那时起，microsoft/TypeScript#37580遇到这个并将其称为错误。和 microsoft/TypeScript#41213也遇到了这个并将其称为错误。所以也许这是一个已知的错误。但我不知道何时或是否会解决这个问题。

如果这是您唯一的问题，您可以做的权宜之计是注释 e2显式回调参数:

const asyncHandler: Handler<number> = async (e2: object) => { return 1 }

但这当然不能解决上面的原始问题:

asyncHandler({}) // still an error

所以我这里的建议还是注释asyncHandler本身为 AsyncHandler<number>并完成它。

Playground link to code