Class Decorator

Represents a base decorator class.

Hierarchy (View Summary)

Decorator
- Modifier

Index

Constructors

Properties

_classRef _from _index? _key _method?

Accessors

classRef from index isClass key method

Methods

decorate decorateUnknown

Constructors

constructor

new Decorator(): Decorator
Returns Decorator

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>
- Defined in decorator/classes/Decorator.ts:31
set classRef(value: Record<string, any>): void
Parameters
- value: Record<string, any>
Returns void
- Defined in decorator/classes/Decorator.ts:34

from

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

Returns Record<string, any>
- Defined in decorator/classes/Decorator.ts:42
set from(value: Record<string, any>): void
Parameters
- value: Record<string, any>
Returns void
- 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
- Defined in decorator/classes/Decorator.ts:24

isClass

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

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

key

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

Returns string
- 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>
- Defined in decorator/classes/Decorator.ts:59

Methods

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.
- 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.
- Defined in decorator/classes/Decorator.ts:78