Helper class providing Nest reflection capabilities.
class Reflector {
get<TResult = any, TKey = any>(metadataKey: TKey, target: any): TResult
getAll<TResult extends any[] = any[], TKey = any>(metadataKey: TKey, targets: any[]): TResult
getAllAndMerge<TResult extends any[] = any[], TKey = any>(metadataKey: TKey, targets: any[]): TResult
getAllAndOverride<TResult = any, TKey = any>(metadataKey: TKey, targets: any[]): TResult
}
Methods
get()
|
|---|
|
Retrieve metadata for a specified key for a specified target.
|
get<TResult = any, TKey = any>(metadataKey: TKey, target: any): TResult
Parameters
| Option |
Type |
Description |
metadataKey
|
TKey |
lookup key for metadata to retrieve
|
target
|
any |
context (decorated object) to retrieve metadata from
|
Examples
`const roles = this.reflector.get('roles', context.getHandler());`
Returns
TResult
|
getAll()
|
|---|
|
Retrieve metadata for a specified key for a specified set of targets.
|
getAll<TResult extends any[] = any[], TKey = any>(metadataKey: TKey, targets: any[]): TResult
Parameters
| Option |
Type |
Description |
metadataKey
|
TKey |
lookup key for metadata to retrieve
|
targets
|
any[] |
context (decorated objects) to retrieve metadata from
|
Returns
TResult
|
getAllAndMerge()
|
|---|
|
Retrieve metadata for a specified key for a specified set of targets and merge results.
|
getAllAndMerge<TResult extends any[] = any[], TKey = any>(metadataKey: TKey, targets: any[]): TResult
Parameters
| Option |
Type |
Description |
metadataKey
|
TKey |
lookup key for metadata to retrieve
|
targets
|
any[] |
context (decorated objects) to retrieve metadata from
|
Returns
TResult
|
getAllAndOverride()
|
|---|
|
Retrieve metadata for a specified key for a specified set of targets and return a first not undefined value.
|
getAllAndOverride<TResult = any, TKey = any>(metadataKey: TKey, targets: any[]): TResult
Parameters
| Option |
Type |
Description |
metadataKey
|
TKey |
lookup key for metadata to retrieve
|
targets
|
any[] |
context (decorated objects) to retrieve metadata from
|
Returns
TResult
|
