Class Modifier<ToModify>

Represents a modifier for decorators.

Type Parameters

ToModify extends Decorator = Decorator

Hierarchy (View Summary)

Decorator
- Modifier

Index

Constructors

constructor

new Modifier<ToModify extends Decorator = Decorator>(
toModify: ModifyFunction<ToModify>,
modifyTypes: Constructor<ToModify>[],
): Modifier<ToModify>
Constructor to initialize a modifier.
Type Parameters
- ToModify extends Decorator = Decorator
Parameters
- toModify: ModifyFunction<ToModify>
  The function to modify the decorator.
- modifyTypes: Constructor<ToModify>[]
  The list of types that can be modified.
Returns Modifier<ToModify>
Overrides Decorator.constructor
- Defined in decorator/classes/Modifier.ts:32

Properties

`Protected`_classRef

_classRef: Record<string, any>

`Protected`_from

_from: Record<string, any>

`Protected` `Optional`_index

_index?: number

`Protected`_key

_key: string

`Protected` `Optional`_method

_method?: Record<string, any>

Accessors

classRef

get classRef(): Record<string, any>
Gets or sets the class reference being decorated.

Returns Record<string, any>
Inherited from Decorator.classRef
- Defined in decorator/classes/Decorator.ts:31
set classRef(value: Record<string, any>): void
Parameters
- value: Record<string, any>
Returns void
Inherited from Decorator.classRef
- Defined in decorator/classes/Decorator.ts:34

from

get from(): Record<string, any>
Gets or sets the originating class reference.

Returns Record<string, any>
Inherited from Decorator.from
- Defined in decorator/classes/Decorator.ts:42
set from(value: Record<string, any>): void
Parameters
- value: Record<string, any>
Returns void
Inherited from Decorator.from
- Defined in decorator/classes/Decorator.ts:45

index

get index(): undefined | number
Gets the index of the parameter being decorated, if applicable.

Returns undefined | number
Inherited from Decorator.index
- Defined in decorator/classes/Decorator.ts:24

isClass

get isClass(): boolean
Determines if the target is a class.

Returns boolean
Inherited from Decorator.isClass
- Defined in decorator/classes/Decorator.ts:66

key

get key(): string
Gets the key of the property or method being decorated.

Returns string
Inherited from Decorator.key
- Defined in decorator/classes/Decorator.ts:52

method

get method(): undefined | Record<string, any>
Gets the method descriptor if the target is a method.

Returns undefined | Record<string, any>
Inherited from Decorator.method
- Defined in decorator/classes/Decorator.ts:59

Methods

applyModifications

applyModifications(original: ToModify): unknown
Applies modifications to the specified decorator.
Parameters
- original: ToModify
  The decorator to modify.
Returns unknown
The result of the modification function.
- Defined in decorator/classes/Modifier.ts:89

decorate

decorate(
    classRef: Record<string, any>,
    key: string,
    method?: Record<string, any>,
    from?: Record<string, any>,
    index?: number,
): this
Applies the decoration to the specified target.
Parameters
- classRef: Record<string, any>
  The class reference.
- key: string
  The property key.
- Optionalmethod: Record<string, any>
  The method descriptor.
- Optionalfrom: Record<string, any>
  The originating class reference.
- Optionalindex: number
  The parameter index.
Returns this
The current instance.
Inherited from Decorator.decorate
- Defined in decorator/classes/Decorator.ts:109

decorateUnknown

decorateUnknown(
    classRef: Record<string, any>,
    key?: string,
    method?: PropertyDescriptor,
    index?: number,
): this
Decorates an unknown type (class, method, or property).
Parameters
- classRef: Record<string, any>
  The class reference.
- Optionalkey: string
  The property key.
- Optionalmethod: PropertyDescriptor
  The method descriptor.
- Optionalindex: number
  The parameter index.
Returns this
The current instance.
Inherited from Decorator.decorateUnknown
- Defined in decorator/classes/Decorator.ts:78

`Static`applyFromModifierListToList

applyFromModifierListToList(
modifiers: Modifier<Decorator>[],
originals: Decorator[],
): Promise<void>
Applies the modifications from a list of modifiers to a list of decorators.
Parameters
- modifiers: Modifier<Decorator>[]
  The list of modifiers.
- originals: Decorator[]
  The list of decorators to modify.
Returns Promise<void>
A promise that resolves when all modifications are applied.
- Defined in decorator/classes/Modifier.ts:60

`Static`create

create<ToModifyEx extends Decorator>(
toModify: ModifyFunction<ToModifyEx>,
...modifyTypes: Constructor<ToModifyEx>[],
): Modifier<ToModifyEx>
Creates a new modifier instance.
Type Parameters
- ToModifyEx extends Decorator
Parameters
- toModify: ModifyFunction<ToModifyEx>
  The function to modify the decorator.
- ...modifyTypes: Constructor<ToModifyEx>[]
  The list of types that can be modified.
Returns Modifier<ToModifyEx>
A new modifier instance.
- Defined in decorator/classes/Modifier.ts:47

Class Modifier<ToModify>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Modifier<ToModify>

Properties

Protected_classRef

Protected_from

Protected Optional_index

Protected_key

Protected Optional_method

Accessors

classRef

Returns Record<string, any>

Parameters

Returns void

from

Returns Record<string, any>

Parameters

Returns void

index

Returns undefined | number

isClass

Returns boolean

key

Returns string

method

Returns undefined | Record<string, any>

Methods

applyModifications

Parameters

Returns unknown

decorate

Parameters

Returns this

decorateUnknown

Parameters

Returns this

StaticapplyFromModifierListToList

Parameters

Returns Promise<void>

Staticcreate

Type Parameters

Parameters

Returns Modifier<ToModifyEx>

Settings

On This Page

`Protected`_classRef

`Protected`_from

`Protected` `Optional`_index

`Protected`_key

`Protected` `Optional`_method

`Static`applyFromModifierListToList

`Static`create