多态装饰器的 TypeScript 声明

Question

我正在为react-tracking 编写环境声明。它公开了一个 track 装饰器，可以在类 和 方法上使用。

来自文档的简化示例：

import track from 'react-tracking'

@track({ page: 'FooPage' })
export default class FooPage extends React.Component {

  @track({ action: 'click' })
  handleClick = () => {
    // ...
  }
}

在我的环境声明文件中，我希望能够执行以下操作并让 TypeScript 选择正确的重载：

declare function track(trackingInfo?: any, options?: any): <T>(component: T) => T
declare function track(trackingInfo?: any, options?: any): any

export default track

虽然这对组件类很有效，但对于具有以下错误的方法却失败了：

[ts] Unable to resolve signature of method decorator when called as an expression.

查看 TS 为这个装饰器应用程序选择的类型表明它没有回退到应该匹配任何内容的签名，而是回退到组件类之一。

是否可以输入多态装饰器？如果是这样，我做错了什么？

---

更新：这是一个简化的简化示例。

第一个是单态的，按预期工作：

function trackClass(trackingInfo?: any, options?: any): ClassDecorator {
  return null
}

function trackMethod(trackingInfo?: any, options?: any): MethodDecorator {
  return null
}

@trackClass({})
class Foo {
  @trackMethod({})
  someMethod() {}
}

第二个例子是多态的，对两者都失败了：

function track(trackingInfo?: any, options?: any): ClassDecorator | MethodDecorator {
  return null
}

@track({})
class Bar {
  @track({})
  someMethod() {}
}

Answer 1

TypeScript 的 lib.d.ts 有一个 ClassDecorator 和一个 MethodDecorator 类型：

declare type ClassDecorator = <TFunction extends Function>(target: TFunction) => TFunction | void;

declare type MethodDecorator = <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void;

您可以做以下两件事之一：

1. 创建一个具有与两者兼容的重载的类型：

   interface TrackDecorator {
       // Class decorator overload
       <TFunction extends Function>(target: TFunction): TFunction;
   
       // Property decorator overload
       <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T>;
   }
   
   export default function track(trackingData?: object): TrackDecorator;
   

2. 派生一个类型以适当地组合重载。

   interface TrackDecorator extends ClassDecorator, MethodDecorator { }
   export default function track(trackingData?: object): TrackDecorator;
   

前者允许您更具体，但后者会将您绑定到 TypeScript 为装饰器考虑的任何版本（换句话说，如果规范发生变化，则暗示react-tracking 支持任一版本）。