时间戳

首页 > 解决方案 > 区分打字稿类型中的装饰类方法

typescript - 区分打字稿类型中的装饰类方法

问题描述

我想创建一个泛型类型，它只从类定义中选择修饰方法。

function test(ctor: any, methodName: any) {}

class A {
    @test
    public x() {}

    public y() {}
}

type DecoratedOnly<T> = {
    [P in keyof T]: T[P] extends /* Magic Happens */ ? T[P] : never;
};

let a: DecoratedOnly<A> = {} as any;
a.x(); // ok
a.y(); // never!

是否可以推断类的修饰方法，因此DecoratedOnly泛型类型保持修饰x()方法不变并省略非修饰y()方法？

标签： typescripttypescript-typingstypescript-generics

解决方案

据我所知，答案可能是“不”。装饰器目前不改变类型，因此类型系统不会注意到装饰方法和未装饰方法之间的区别。人们已经要求为类装饰器提供类似的东西（而不是像您正在使用的方法装饰器），在这里......但这是一个有争议的问题。有些人非常强烈地认为装饰器不应该被类型系统观察到，而另一些人则同样强烈地认为不同。在 JavaScript 中的装饰器最终确定之前，TypeScript 的维护者不太可能对它们的工作方式进行任何更改，因此我不希望这里有任何立即解决方案。

但是，如果我们备份并尝试提出一个与应用这些装饰器具有相同效果的解决方案，同时跟踪文件系统中发生的事情呢？

为了得到一些具体的东西，我test()要做一些事情：

function test(
  target: any,
  propertyKey: string,
  descriptor: PropertyDescriptor
) {
  console.log(
    "decorated test on target",
    target,
    "propertyKey",
    propertyKey,
    "descriptor",
    descriptor
  );
}

当你A这样做时：

class A {
  @test
  public x() {}

  public y() {}
}

您会得到以下日志：decorated test on target Object { … } propertyKey x descriptor Object { value: x(), writable: true, enumerable: false, configurable: true }

由于我们无法检测到何时应用了装饰器，如果我们根本不使用@test装饰样式，而是test在属性描述符上调用实际函数，这就是装饰器编译成的方法呢？如果我们创建自己的 apply-instance-method-decorator 函数，我们可以让该函数进行装饰并跟踪类型系统中装饰了哪些方法。像这样的东西：

function decorateInstanceMethods<T, K extends Extract<keyof T, string>>(
  ctor: new (...args: any) => T,
  decorator: (
    target: any,
    propertyKey: string,
    descriptor: PropertyDescriptor
  ) => void,
  ...methodsToDecorate: K[]
): T & { decoratedMethods: K[] } {
  methodsToDecorate.forEach(m =>
    decorator(
      ctor.prototype,
      m,
      Object.getOwnPropertyDescriptor(ctor.prototype, m)!
    )
  );
  return Object.assign(ctor.prototype, {
    decoratedMethods: methodsToDecorate
  });
}

该功能可以隐藏在某个图书馆的某个地方。以下是你如何制作A和装饰它test：

class A {
  public x() {}
  public y() {}
}

const DecoratedAPrototype = decorateInstanceMethods(A, test, "x");

这最终记录了与以前相同的内容：decorated test on target Object { … } propertyKey x descriptor Object { value: x(), writable: true, enumerable: false, configurable: true }

但是现在，DecoratedAPrototypeisA.prototype添加了一个decoratedMethods属性，其类型为Array<"x">，因此您可以这样做：

type DecoratedOnly<
  T extends {
    decoratedMethods: (keyof T)[];
  }
> = Pick<T, T["decoratedMethods"][number]>;

const a: DecoratedOnly<typeof DecoratedAPrototype> = new A();
a.x(); // okay
a.y(); // error, property "y" does not exist on DecoratedOnly<typeof DecoratedAPrototype>

您可以看到该A类型仍然不知道装饰了哪些方法，但是知道DecoratedAPrototype。这足以给你你正在寻找的行为（我使用Pick了所以省略的属性只是不知道存在并且没有明确never......我猜这不是超级重要）

那对你有用吗？是的，它比仅仅使用装饰器要复杂一些，但它是我能得到的最接近你想要的东西。

无论如何，希望这会有所帮助。祝你好运！

链接到代码

推荐阅读