feat(types): ClassDecorator, MethodDecorator

Signed-off-by: Lexus Drumgold <[email protected]>

.eslintrc.base.cjs

@@ -845,6 +845,7 @@ const config = {
         '@typescript-eslint/consistent-indexed-object-style': 0,
         '@typescript-eslint/no-base-to-string': 0,
         '@typescript-eslint/no-empty-function': 0,
+        '@typescript-eslint/no-invalid-void-type': 0,
         '@typescript-eslint/no-unused-expressions': 0,
         '@typescript-eslint/prefer-ts-expect-error': 0,
         '@typescript-eslint/require-await': 0,

.eslintrc.cjs

@@ -28,6 +28,12 @@ const config = {
         '@typescript-eslint/ban-types': 0
       }
     },
+    {
+      files: ['src/types/decorator-class.ts', 'src/types/decorator-method.ts'],
+      rules: {
+        '@typescript-eslint/no-invalid-void-type': 0
+      }
+    },
     {
       files: ['src/utils/__tests__/ksort.spec.ts'],
       rules: {

src/interfaces/property-descriptor.ts

@@ -52,10 +52,10 @@ interface PropertyDescriptor<T = any> {
    * being assigned to the property) and with `this` set to the object through
    * which the property is assigned.
    *
-   * @param {T} v - Value being assigned to property
+   * @param {T} value - Value being assigned to property
    * @return {void} Nothing when complete
    */
-  set?(v: T): void
+  set?(value: T): void
 
   /**
    * Value associated with the property.

src/types/__tests__/decorator-class.spec-d.ts

@@ -0,0 +1,20 @@
+/**
+ * @file Type Tests - ClassDecorator
+ * @module tutils/types/tests/unit-d/ClassDecorator
+ */
+
+import type Vehicle from '#fixtures/types/vehicle'
+import type Class from '../class'
+import type TestSubject from '../decorator-class'
+
+describe('unit-d:types/ClassDecorator', () => {
+  type T = Class<Vehicle, [vin: Vehicle['vin']]>
+
+  it('should be callable with [T]', () => {
+    expectTypeOf<TestSubject<T>>().parameters.toEqualTypeOf<[T]>()
+  })
+
+  it('should return T | void', () => {
+    expectTypeOf<TestSubject<T>>().returns.toEqualTypeOf<T | void>()
+  })
+})

src/types/__tests__/decorator-method.spec-d.ts

@@ -0,0 +1,32 @@
+/**
+ * @file Type Tests - MethodDecorator
+ * @module tutils/types/tests/unit-d/MethodDecorator
+ */
+
+import type Vehicle from '#fixtures/types/vehicle'
+import type { PropertyDescriptor } from '#src/interfaces'
+import type Class from '../class'
+import type TestSubject from '../decorator-method'
+import type Fn from '../fn'
+import type OwnPropertyKey from '../property-key-own'
+
+describe('unit-d:types/MethodDecorator', () => {
+  type T = Fn<[vin: Vehicle['vin']], Vehicle>
+  type U = Class<Vehicle, [vin: Vehicle['vin']]>
+
+  it('should be callable with [U, OwnPropertyKey, PropertyDescriptor<T>]', () => {
+    // Arrange
+    type Expect = [U, OwnPropertyKey, PropertyDescriptor<T>]
+
+    // Expect
+    expectTypeOf<TestSubject<T, U>>().parameters.toEqualTypeOf<Expect>()
+  })
+
+  it('should return PropertyDescriptor<T> | void', () => {
+    // Arrange
+    type Expect = PropertyDescriptor<T> | void
+
+    // Expect
+    expectTypeOf<TestSubject<T>>().returns.toEqualTypeOf<Expect>()
+  })
+})

src/types/decorator-class.ts

@@ -0,0 +1,23 @@
+/**
+ * @file Type Definitions - ClassDecorator
+ * @module tutils/types/ClassDecorator
+ */
+
+import type Constructor from './constructor'
+import type AbstractConstructor from './constructor-abstract'
+
+/**
+ * A class decorator.
+ *
+ * @see https://www.typescriptlang.org/docs/handbook/decorators.html#class-decorators
+ *
+ * @template T - Class type
+ *
+ * @param {T} target - Class declaration
+ * @return {T | void} Class declaration or `undefined`
+ */
+type ClassDecorator<T extends AbstractConstructor<any> = Constructor<any>> = (
+  target: T
+) => T | void
+
+export type { ClassDecorator as default }

src/types/decorator-method.ts

@@ -0,0 +1,34 @@
+/**
+ * @file Type Definitions - MethodDecorator
+ * @module tutils/types/MethodDecorator
+ */
+
+import type { PropertyDescriptor } from '#src/interfaces'
+import type DecoratorTarget from './decorator-target'
+import type Fn from './fn'
+import type OwnPropertyKey from './property-key-own'
+
+/**
+ * A method decorator.
+ *
+ * @see {@linkcode DecoratorTarget}
+ * @see https://www.typescriptlang.org/docs/handbook/decorators.html#method-decorators
+ *
+ * @template T - Property descriptor value type
+ * @template U - Class constructor or instance type
+ *
+ * @param {U} target - Class declaration or prototype
+ * @param {OwnPropertyKey} key - Method name
+ * @param {PropertyDescriptor<T>} descriptor - Property descriptor for `key`
+ * @return {PropertyDescriptor<T> | void} Property descriptor or `undefined`
+ */
+type MethodDecorator<
+  T extends Fn = Fn,
+  U extends DecoratorTarget = DecoratorTarget
+> = (
+  target: U,
+  key: OwnPropertyKey,
+  descriptor: PropertyDescriptor<T>
+) => PropertyDescriptor<T> | void
+
+export type { MethodDecorator as default }

src/types/index.ts

@@ -17,6 +17,8 @@ export type { default as Constructor } from './constructor'
 export type { default as AbstractConstructor } from './constructor-abstract'
 export type { default as ContinuousValue } from './continuous-value'
 export type { default as Crush } from './crush'
+export type { default as ClassDecorator } from './decorator-class'
+export type { default as MethodDecorator } from './decorator-method'
 export type { default as DecoratorTarget } from './decorator-target'
 export type { default as Defaults } from './defaults'
 export type { default as Digit } from './digit'