Рефлектор

Створення кастомних декораторів

Використовуючи клас Reflector (не плутайте зі стандартним Reflect), ви можете створити кастомний декоратор на будь-якому рівні:

import { Reflector } from '@ditsmod/core/di';

const classLevel = Reflector.makeClassDecorator();
const propertyLevel = Reflector.makePropDecorator();
const parameterLevel = Reflector.makeParamDecorator();

@classLevel()
class Service1 {
  @propertyLevel()
  method1(@parameterLevel() param1: string) {}

  @propertyLevel()
  property1: string;
}

const metadata = Reflector.collectMetadata(Service1);
console.log(metadata);

В даному прикладі показано створення фабрик декораторів на рівні класу, властивостей та параметрів. Оскільки тут для жодної фабрики не передано трансформерів, дані, що передаються у фабрику, будуть повертатись у вигляді масиву. В наступному прикладі для фабрики декораторів передається простий трансформер, який пропускає через себе єдиний аргумент транзитом:

import { Reflector } from '@ditsmod/core/di';

const classLevel = Reflector.makeClassDecorator((obj: any) => obj);

@classLevel({ one: 1, two: 2 })
class Service1 {}

const metadata = Reflector.collectMetadata(Service1);
console.log(metadata?.constructor.decorators[0].value); // Print { one: 1, two: 2 }

Зверніть увагу, що метадані на рівні класу прив'язуються до властивості metadata.constructor.

Рефлектор зберігає метадані всього ланцюжку наслідувань класів:

import { Reflector } from '@ditsmod/core/di';

const classLevel = Reflector.makeClassDecorator((val?: string) => val);

class SomeService {}
class ExtendedService extends SomeService {}

@classLevel()
class Parent {
  constructor(param1: SomeService) {}
}

@classLevel()
class Child extends Parent {
  constructor(param1: ExtendedService) {
    super(param1);
  }
}

const metadata = Reflector.collectMetadata(Child);
console.log(metadata?.constructor.paramChain);

В даному прикладі клас Child розширює клас Parent і перевизначає тип першого параметра в конструкторі. У виділеному рядку показано де зберігаються параметри для усього ланцюжка наслідувань класів - metadata.constructor.paramChain. Це саме стосується і metadata.constructor.decoratorChain.

Складні типи декораторів

TypeScript може вивести тип простої функції, що передається у Reflector.make*Decorator(), яка призначається для трансформації метаданих. Якщо вам потрібний більш складніші типи, ви можете оголосити бажаний тип цієї функції за допомогою інтерфейсу:

const inject: InjectDecorator = Reflector.makeParamDecorator(
  (token, input?) => ({ token, input }) satisfies InjectTransformResult,
  'inject',
);

interface InjectDecorator {
  (token: NonNullable<unknown>): any;
  <T extends NonNullable<unknown>>(token: NonNullable<unknown>, input: T): any;
}

interface InjectTransformResult {
  token: NonNullable<unknown>;
  input?: NonNullable<unknown>;
}

Тут показано як саме Ditsmod оголошує тип для декоратора параметрів inject. В даному разі, складність типів полягає у тому, що функція-трансформер має дві сигнатури, а TypeScript, на даний момент, не вміє виводити більше однієї сигнатури.