如何在 Typescript 装饰器工厂参数上强制使用与其应用的属性相同的类型？

Question

如何确保装饰器工厂的参数类型与其应用的属性类型相匹配？

class MyClass {
    @myDecorator("a string")
    public someProp?: string; // okay

    @myDecorator(4)
    public someProp?: number; // okay

    @myDecorator()
    public someProp?: number; // okay

    @myDecorator("a string")
    public someProp?: boolean; // error
}

我找到了一个适用于特定类型的解决方案，但我希望它适用于任何属性类型。 我可以检查运行时，但这似乎不是很用户友好。

有谁知道这是否可能？

Answer 1

是的，这是可能的。 您需要在其参数中使装饰器工厂泛型，并确保您装饰的目标和属性具有兼容的值类型。 这是一种方法：

type KeysMatchingForWrites<T, V> = { [K in keyof T]-?: V extends T[K] ? K : never }[keyof T]

const myDecorator = <V = any>(val?: V) =>
  <T>(target: T, prop: KeysMatchingForWrites<T, V>) => {
    // impl here
    if (typeof val !== "undefined") {
      // you will need an assertion to assign anything
      target[prop] = val as any as T[KeysMatchingForWrites<T, V>];  
    }
  }

KeysMatchingForWrites<T, V>返回T的所有键，这些键的属性可以接受写入它们的V类型的值。 所以如果T是{narrow: "", normal: string, wide: unknown}并且V是string ，那么KeysMatching<T, V>是"normal" | "wide" "normal" | "wide" 。

然后myDecorator()接受一个V类型的值，并返回一个装饰器，其目标是某种类型T ，其属性键是KeysMatchingForWrites<T, V> 。 请注意，在myDecorator()的实现中，您可能必须使用类型断言来实际执行赋值或等效操作。 上面的输入主要是为了让人们正确调用装饰器，而不是正确实现装饰器。 而且我还使值可选， V类型默认为any以支持您不将参数传递给装饰器工厂的情况。 上面的特定类型和实现是否适合您的需求与您的用例有关； 我在这里的主要观点是表明它确实可以做到。

让我们看看它的实际效果：

class MyClass {
  @myDecorator("a string")
  public someProp?: string; // okay

  @myDecorator(4)
  public someProp1?: number; // okay

  @myDecorator()
  public someProp2?: number; // okay

  @myDecorator("a string")
  public someProp3?: boolean; // error
  // Argument of type '"someProp3"' is not assignable to parameter of type '"someProp"'
}

看起来挺好的。 最后一个是错误，因为@myDecorator("a string")预期应用于string类型的属性，而MyClass唯一的一个是名为someProp的属性。 由于someProp3不是someProp ，您会收到上述错误。 诚然，如果错误消息说“ boolean不可分配给string ”会更好，但至少它在正确的地方是一个错误。

---

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

代码链接