Skip to content

Class: Reflector

Defined in: packages/core/src/di/reflector.ts:15

Helper class for retrieving metadata from classes and methods using reflect-metadata.

Constructors

Constructor

ts
new Reflector(): Reflector;

Returns

Reflector

Methods

get()

Call Signature

ts
get<T>(metadataKey, target): T | undefined;

Defined in: packages/core/src/di/reflector.ts:24

Retrieve metadata for a specified key from a target object.

Type Parameters
Type ParameterDefault type
Tunknown
Parameters
ParameterTypeDescription
metadataKeystring | symbolthe metadata key
targetobject | Constructorthe target object
Returns

T | undefined

the metadata value

Call Signature

ts
get<T>(
   metadataKey, 
   target, 
   propertyKey
): T | undefined;

Defined in: packages/core/src/di/reflector.ts:38

Retrieve metadata for a specified key from a target object's method.

Type Parameters
Type ParameterDefault type
Tunknown
Parameters
ParameterTypeDescription
metadataKeystring | symbolthe metadata key
targetobject | Constructorthe target object
propertyKeystring | symbolthe property key (method name)
Returns

T | undefined

the metadata value


getAllAndMerge()

ts
getAllAndMerge<T>(metadataKey, targets): T | undefined;

Defined in: packages/core/src/di/reflector.ts:122

Retrieve metadata for a specified key from multiple targets and merge the results. Arrays will be concatenated, objects will be merged, and primitive values will be collected into an array.

Type Parameters

Type ParameterDefault type
Tunknown

Parameters

ParameterTypeDescription
metadataKeystring | symbolthe metadata key
targets(object | Constructor)[]array of target objects to check

Returns

T | undefined

merged metadata value


getAllAndOverride()

ts
getAllAndOverride<T>(metadataKey, targets): T | undefined;

Defined in: packages/core/src/di/reflector.ts:99

Retrieve metadata for a specified key from multiple targets and return the first defined value. This method is useful when you want to get metadata from both class and method, where method metadata should override class metadata.

Type Parameters

Type ParameterDefault type
Tunknown

Parameters

ParameterTypeDescription
metadataKeystring | symbolthe metadata key
targets(object | Constructor)[]array of target objects to check

Returns

T | undefined

the first defined metadata value


getMetadataKeys()

Call Signature

ts
getMetadataKeys(target): (string | symbol)[];

Defined in: packages/core/src/di/reflector.ts:64

Retrieve all metadata keys from a target object.

Parameters
ParameterTypeDescription
targetobject | Constructorthe target object
Returns

(string | symbol)[]

array of metadata keys

Call Signature

ts
getMetadataKeys(target, propertyKey): (string | symbol)[];

Defined in: packages/core/src/di/reflector.ts:74

Retrieve all metadata keys from a target object's method.

Parameters
ParameterTypeDescription
targetobject | Constructorthe target object
propertyKeystring | symbolthe property key (method name)
Returns

(string | symbol)[]

array of metadata keys

Released under the MIT License.