Class MetadataUtilities`Abstract`

Utilities for handling Metadata.

Index

Constructors

Methods

getBackupResourceMetadata getControllerBaseRoute getControllerBelongsTo getControllerHasRole getControllerIsLoggedIn getControllerIsNotLoggedIn getControllerRequire2fa getControllerRoutes getControllerSkipBelongsTo getControllerSkipHasRole getControllerSkipIsLoggedIn getControllerSkipIsNotLoggedIn getControllerSkipRequire2fa getEntityMetadata getFilePath getInjectParamTokens getModelProperties getParamTypes getRouteBelongsTo getRouteBody getRouteCurrentUser getRouteCurrentWebsocketConnection getRouteHasRole getRouteHeaderParams getRouteIsLoggedIn getRouteIsNotLoggedIn getRoutePathParams getRouteQueryParams getRouteRequire2fa getRouteResponses getRouteSkipAuth getRouteSkipBelongsTo getRouteSkipHasRole getRouteSkipIsLoggedIn getRouteSkipIsNotLoggedIn getRouteSkipRequire2fa getWebsocketController getWebsocketControllerRoutes setBackupResourceMetadata setControllerBaseRoute setControllerBelongsTo setControllerHasRole setControllerIsLoggedIn setControllerIsNotLoggedIn setControllerRequire2fa setControllerRoutes setControllerSkipBelongsTo setControllerSkipHasRole setControllerSkipIsLoggedIn setControllerSkipIsNotLoggedIn setControllerSkipRequire2fa setDiToken setEntityMetadata setFilePath setInjectParamTokens setModelProperties setRouteBelongsTo setRouteBody setRouteCurrentUser setRouteCurrentWebsocketConnection setRouteHasRole setRouteHeaderParams setRouteIsLoggedIn setRouteIsNotLoggedIn setRoutePathParams setRouteQueryParams setRouteRequire2fa setRouteResponses setRouteSkipAuth setRouteSkipBelongsTo setRouteSkipHasRole setRouteSkipIsLoggedIn setRouteSkipIsNotLoggedIn setRouteSkipRequire2fa setWebsocketController setWebsocketControllerRoutes

Constructors

constructor

new MetadataUtilities(): MetadataUtilities
Returns MetadataUtilities

Methods

`Static`getBackupResourceMetadata

getBackupResourceMetadata(
entity: Newable<BackupResourceInterface>,
): BackupResourceMetadata | undefined
Parameters
- entity: Newable<BackupResourceInterface>
Returns BackupResourceMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:438

`Static`getControllerBaseRoute

getControllerBaseRoute(controller: Function): `/${string}` | undefined
Parameters
- controller: Function
Returns `/${string}` | undefined
- Defined in src/utilities/metadata.utilities.ts:144

`Static`getControllerBelongsTo

getControllerBelongsTo<T extends Newable<BaseEntity>>(
controller: Function,
): BelongsToMetadata<T> | undefined
Type Parameters
- T extends Newable<BaseEntity>
Parameters
- controller: Function
Returns BelongsToMetadata<T> | undefined
- Defined in src/utilities/metadata.utilities.ts:327

`Static`getControllerHasRole

getControllerHasRole(controller: Function): HasRoleMetadata | undefined
Parameters
- controller: Function
Returns HasRoleMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:279

`Static`getControllerIsLoggedIn

getControllerIsLoggedIn(controller: Function): IsLoggedInMetadata | undefined
Parameters
- controller: Function
Returns IsLoggedInMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:238

`Static`getControllerIsNotLoggedIn

getControllerIsNotLoggedIn(
controller: Function,
): IsNotLoggedInMetadata | undefined
Parameters
- controller: Function
Returns IsNotLoggedInMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:471

`Static`getControllerRequire2fa

getControllerRequire2fa(controller: Function): Require2faMetadata | undefined
Parameters
- controller: Function
Returns Require2faMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:375

`Static`getControllerRoutes

getControllerRoutes(controller: Function): ControllerRouteConfiguration[]
Parameters
- controller: Function
Returns ControllerRouteConfiguration[]
- Defined in src/utilities/metadata.utilities.ts:122

`Static`getControllerSkipBelongsTo

getControllerSkipBelongsTo(controller: Function): object | undefined
Parameters
- controller: Function
Returns object | undefined
- Defined in src/utilities/metadata.utilities.ts:335

`Static`getControllerSkipHasRole

getControllerSkipHasRole(controller: Function): object | undefined
Parameters
- controller: Function
Returns object | undefined
- Defined in src/utilities/metadata.utilities.ts:287

`Static`getControllerSkipIsLoggedIn

getControllerSkipIsLoggedIn(controller: Function): object | undefined
Parameters
- controller: Function
Returns object | undefined
- Defined in src/utilities/metadata.utilities.ts:246

`Static`getControllerSkipIsNotLoggedIn

getControllerSkipIsNotLoggedIn(controller: Function): object | undefined
Parameters
- controller: Function
Returns object | undefined
- Defined in src/utilities/metadata.utilities.ts:479

`Static`getControllerSkipRequire2fa

getControllerSkipRequire2fa(
controller: Function,
): Require2faMetadata | undefined
Parameters
- controller: Function
Returns Require2faMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:383

`Static`getEntityMetadata

getEntityMetadata(entity: Newable<unknown>): EntityMetadata | undefined
Parameters
- entity: Newable<unknown>
Returns EntityMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:429

`Static`getFilePath

getFilePath(target: Object): string | undefined
Parameters
- target: Object
Returns string | undefined
- Defined in src/utilities/metadata.utilities.ts:96

`Static`getInjectParamTokens

getInjectParamTokens(target: Object): Record<number, DiToken<unknown>>
Parameters
- target: Object
Returns Record<number, DiToken<unknown>>
- Defined in src/utilities/metadata.utilities.ts:113

`Static`getModelProperties

getModelProperties<T extends Newable<unknown>>(
ctor: T,
): Record<string, PropertyMetadata>
Type Parameters
- T extends Newable<unknown>
Parameters
- ctor: T
Returns Record<string, PropertyMetadata>
- Defined in src/utilities/metadata.utilities.ts:407

`Static`getParamTypes

getParamTypes(target: Object): unknown[]
Parameters
- target: Object
Returns unknown[]
- Defined in src/utilities/metadata.utilities.ts:101

`Static`getRouteBelongsTo

getRouteBelongsTo<T extends Newable<BaseEntity>>(
controller: Function,
controllerMethod: string,
): BelongsToMetadata<T> | undefined
Type Parameters
- T extends Newable<BaseEntity>
Parameters
- controller: Function
- controllerMethod: string
Returns BelongsToMetadata<T> | undefined
- Defined in src/utilities/metadata.utilities.ts:300

`Static`getRouteBody

getRouteBody(
controller: Function,
controllerMethod: string,
): BodyMetadata | undefined
Parameters
- controller: Function
- controllerMethod: string
Returns BodyMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:189

`Static`getRouteCurrentUser

getRouteCurrentUser(
controller: Function,
controllerMethod: string,
): CurrentUserMetadata | undefined
Parameters
- controller: Function
- controllerMethod: string
Returns CurrentUserMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:201

`Static`getRouteCurrentWebsocketConnection

getRouteCurrentWebsocketConnection(
controller: Function,
controllerMethod: string,
): CurrentWebsocketConnectionMetadata | undefined
Parameters
- controller: Function
- controllerMethod: string
Returns CurrentWebsocketConnectionMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:510

`Static`getRouteHasRole

getRouteHasRole(
controller: Function,
controllerMethod: string,
): HasRoleMetadata | undefined
Parameters
- controller: Function
- controllerMethod: string
Returns HasRoleMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:255

`Static`getRouteHeaderParams

getRouteHeaderParams(
controller: Function,
controllerMethod: string,
): Record<number, HeaderParamMetadata>
Parameters
- controller: Function
- controllerMethod: string
Returns Record<number, HeaderParamMetadata>
- Defined in src/utilities/metadata.utilities.ts:177

`Static`getRouteIsLoggedIn

getRouteIsLoggedIn(
controller: Function,
controllerMethod: string,
): IsLoggedInMetadata | undefined
Parameters
- controller: Function
- controllerMethod: string
Returns IsLoggedInMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:214

`Static`getRouteIsNotLoggedIn

getRouteIsNotLoggedIn(
controller: Function,
controllerMethod: string,
): IsNotLoggedInMetadata | undefined
Parameters
- controller: Function
- controllerMethod: string
Returns IsNotLoggedInMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:447

`Static`getRoutePathParams

getRoutePathParams(
controller: Function,
controllerMethod: string,
): Record<number, PathParamMetadata>
Parameters
- controller: Function
- controllerMethod: string
Returns Record<number, PathParamMetadata>
- Defined in src/utilities/metadata.utilities.ts:153

`Static`getRouteQueryParams

getRouteQueryParams(
controller: Function,
controllerMethod: string,
): Record<number, QueryParamMetadata>
Parameters
- controller: Function
- controllerMethod: string
Returns Record<number, QueryParamMetadata>
- Defined in src/utilities/metadata.utilities.ts:165

`Static`getRouteRequire2fa

getRouteRequire2fa(
controller: Function,
controllerMethod: string,
): Require2faMetadata | undefined
Parameters
- controller: Function
- controllerMethod: string
Returns Require2faMetadata | undefined
- Defined in src/utilities/metadata.utilities.ts:348

`Static`getRouteResponses

getRouteResponses(
controller: Function,
controllerMethod: string,
): OpenApiResponse[]
Parameters
- controller: Function
- controllerMethod: string
Returns OpenApiResponse[]
- Defined in src/utilities/metadata.utilities.ts:131

`Static`getRouteSkipAuth

getRouteSkipAuth(
controller: Function,
controllerMethod: string,
): object | undefined
Parameters
- controller: Function
- controllerMethod: string
Returns object | undefined
- Defined in src/utilities/metadata.utilities.ts:393

`Static`getRouteSkipBelongsTo

getRouteSkipBelongsTo(
controller: Function,
controllerMethod: string,
): object | undefined
Parameters
- controller: Function
- controllerMethod: string
Returns object | undefined
- Defined in src/utilities/metadata.utilities.ts:315

`Static`getRouteSkipHasRole

getRouteSkipHasRole(
controller: Function,
controllerMethod: string,
): object | undefined
Parameters
- controller: Function
- controllerMethod: string
Returns object | undefined
- Defined in src/utilities/metadata.utilities.ts:267

`Static`getRouteSkipIsLoggedIn

getRouteSkipIsLoggedIn(
controller: Function,
controllerMethod: string,
): object | undefined
Parameters
- controller: Function
- controllerMethod: string
Returns object | undefined
- Defined in src/utilities/metadata.utilities.ts:226

`Static`getRouteSkipIsNotLoggedIn

getRouteSkipIsNotLoggedIn(
controller: Function,
controllerMethod: string,
): object | undefined
Parameters
- controller: Function
- controllerMethod: string
Returns object | undefined
- Defined in src/utilities/metadata.utilities.ts:459

`Static`getRouteSkipRequire2fa

getRouteSkipRequire2fa(
controller: Function,
controllerMethod: string,
): object | undefined
Parameters
- controller: Function
- controllerMethod: string
Returns object | undefined
- Defined in src/utilities/metadata.utilities.ts:363

`Static`getWebsocketController

getWebsocketController(
controller: Function,
): WebsocketControllerData | undefined
Parameters
- controller: Function
Returns WebsocketControllerData | undefined
- Defined in src/utilities/metadata.utilities.ts:488

`Static`getWebsocketControllerRoutes

getWebsocketControllerRoutes(
controller: Function,
): WebsocketControllerRouteConfiguration[]
Parameters
- controller: Function
Returns WebsocketControllerRouteConfiguration[]
- Defined in src/utilities/metadata.utilities.ts:497

`Static`setBackupResourceMetadata

setBackupResourceMetadata(
entity: Newable<BackupResourceInterface>,
metadata: BackupResourceMetadata,
): void
Parameters
- entity: Newable<BackupResourceInterface>
- metadata: BackupResourceMetadata
Returns void
- Defined in src/utilities/metadata.utilities.ts:434

`Static`setControllerBaseRoute

setControllerBaseRoute(controller: Function, baseRoute: `/${string}`): void
Parameters
- controller: Function
- baseRoute: `/${string}`
Returns void
- Defined in src/utilities/metadata.utilities.ts:140

`Static`setControllerBelongsTo

setControllerBelongsTo<T extends Newable<BaseEntity>>(
controller: Function,
data: BelongsToMetadata<T>,
): void
Type Parameters
- T extends Newable<BaseEntity>
Parameters
- controller: Function
- data: BelongsToMetadata<T>
Returns void
- Defined in src/utilities/metadata.utilities.ts:323

`Static`setControllerHasRole

setControllerHasRole(controller: Function, data: HasRoleMetadata): void
Parameters
- controller: Function
- data: HasRoleMetadata
Returns void
- Defined in src/utilities/metadata.utilities.ts:275

`Static`setControllerIsLoggedIn

setControllerIsLoggedIn(controller: Function, data: IsLoggedInMetadata): void
Parameters
- controller: Function
- data: IsLoggedInMetadata
Returns void
- Defined in src/utilities/metadata.utilities.ts:234

`Static`setControllerIsNotLoggedIn

setControllerIsNotLoggedIn(
controller: Function,
data: IsNotLoggedInMetadata,
): void
Parameters
- controller: Function
- data: IsNotLoggedInMetadata
Returns void
- Defined in src/utilities/metadata.utilities.ts:467

`Static`setControllerRequire2fa

setControllerRequire2fa(controller: Function, data: Require2faMetadata): void
Parameters
- controller: Function
- data: Require2faMetadata
Returns void
- Defined in src/utilities/metadata.utilities.ts:371

`Static`setControllerRoutes

setControllerRoutes(
controller: Function,
routes: ControllerRouteConfiguration[],
): void
Parameters
- controller: Function
- routes: ControllerRouteConfiguration[]
Returns void
- Defined in src/utilities/metadata.utilities.ts:118

`Static`setControllerSkipBelongsTo

setControllerSkipBelongsTo(controller: Function, data: object): void
Parameters
- controller: Function
- data: object
Returns void
- Defined in src/utilities/metadata.utilities.ts:331

`Static`setControllerSkipHasRole

setControllerSkipHasRole(controller: Function, data: object): void
Parameters
- controller: Function
- data: object
Returns void
- Defined in src/utilities/metadata.utilities.ts:283

`Static`setControllerSkipIsLoggedIn

setControllerSkipIsLoggedIn(controller: Function, data: object): void
Parameters
- controller: Function
- data: object
Returns void
- Defined in src/utilities/metadata.utilities.ts:242

`Static`setControllerSkipIsNotLoggedIn

setControllerSkipIsNotLoggedIn(controller: Function, data: object): void
Parameters
- controller: Function
- data: object
Returns void
- Defined in src/utilities/metadata.utilities.ts:475

`Static`setControllerSkipRequire2fa

setControllerSkipRequire2fa(controller: Function, data: object): void
Parameters
- controller: Function
- data: object
Returns void
- Defined in src/utilities/metadata.utilities.ts:379

`Static`setDiToken

setDiToken<T>(target: Object, token?: DiToken<T>): void
Type Parameters
- T
Parameters
- target: Object
- Optionaltoken: DiToken<T>
Returns void
- Defined in src/utilities/metadata.utilities.ts:105

`Static`setEntityMetadata

setEntityMetadata(entity: Newable<unknown>, metadata: EntityMetadata): void
Parameters
- entity: Newable<unknown>
- metadata: EntityMetadata
Returns void
- Defined in src/utilities/metadata.utilities.ts:425

`Static`setFilePath

setFilePath(target: Object, errorStack: string): void
Parameters
- target: Object
- errorStack: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:83

`Static`setInjectParamTokens

setInjectParamTokens(
target: Object,
tokens: Record<number, DiToken<unknown>>,
): void
Parameters
- target: Object
- tokens: Record<number, DiToken<unknown>>
Returns void
- Defined in src/utilities/metadata.utilities.ts:109

`Static`setModelProperties

setModelProperties<T extends Newable<unknown>>(
ctor: T,
properties: Record<string, PropertyMetadata>,
): void
Type Parameters
- T extends Newable<unknown>
Parameters
- ctor: T
- properties: Record<string, PropertyMetadata>
Returns void
- Defined in src/utilities/metadata.utilities.ts:402

`Static`setRouteBelongsTo

setRouteBelongsTo<T extends Newable<BaseEntity>>(
    controller: Function,
    data: BelongsToMetadata<T>,
    controllerMethod: string,
): void
Type Parameters
- T extends Newable<BaseEntity>
Parameters
- controller: Function
- data: BelongsToMetadata<T>
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:292

`Static`setRouteBody

setRouteBody(
    controller: Function,
    body: BodyMetadata,
    controllerMethod: string,
): void
Parameters
- controller: Function
- body: BodyMetadata
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:185

`Static`setRouteCurrentUser

setRouteCurrentUser(
    controller: Function,
    body: CurrentUserMetadata,
    controllerMethod: string,
): void
Parameters
- controller: Function
- body: CurrentUserMetadata
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:197

`Static`setRouteCurrentWebsocketConnection

setRouteCurrentWebsocketConnection(
    controller: Function,
    metadata: CurrentWebsocketConnectionMetadata,
    controllerMethod: string,
): void
Parameters
- controller: Function
- metadata: CurrentWebsocketConnectionMetadata
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:502

`Static`setRouteHasRole

setRouteHasRole(
    controller: Function,
    data: HasRoleMetadata,
    controllerMethod: string,
): void
Parameters
- controller: Function
- data: HasRoleMetadata
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:251

`Static`setRouteHeaderParams

setRouteHeaderParams(
    controller: Function,
    params: Record<number, HeaderParamMetadata>,
    controllerMethod: string,
): void
Parameters
- controller: Function
- params: Record<number, HeaderParamMetadata>
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:173

`Static`setRouteIsLoggedIn

setRouteIsLoggedIn(
    controller: Function,
    data: IsLoggedInMetadata,
    controllerMethod: string,
): void
Parameters
- controller: Function
- data: IsLoggedInMetadata
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:210

`Static`setRouteIsNotLoggedIn

setRouteIsNotLoggedIn(
    controller: Function,
    data: IsNotLoggedInMetadata,
    controllerMethod: string,
): void
Parameters
- controller: Function
- data: IsNotLoggedInMetadata
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:443

`Static`setRoutePathParams

setRoutePathParams(
    controller: Function,
    params: Record<number, PathParamMetadata>,
    controllerMethod: string,
): void
Parameters
- controller: Function
- params: Record<number, PathParamMetadata>
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:149

`Static`setRouteQueryParams

setRouteQueryParams(
    controller: Function,
    params: Record<number, QueryParamMetadata>,
    controllerMethod: string,
): void
Parameters
- controller: Function
- params: Record<number, QueryParamMetadata>
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:161

`Static`setRouteRequire2fa

setRouteRequire2fa(
    controller: Function,
    data: Require2faMetadata,
    controllerMethod: string,
): void
Parameters
- controller: Function
- data: Require2faMetadata
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:340

`Static`setRouteResponses

setRouteResponses(
    controller: Function,
    data: OpenApiResponse[],
    controllerMethod: string,
): void
Parameters
- controller: Function
- data: OpenApiResponse[]
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:127

`Static`setRouteSkipAuth

setRouteSkipAuth(
    controller: Function,
    data: object,
    controllerMethod: string,
): void
Parameters
- controller: Function
- data: object
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:389

`Static`setRouteSkipBelongsTo

setRouteSkipBelongsTo(
    controller: Function,
    data: object,
    controllerMethod: string,
): void
Parameters
- controller: Function
- data: object
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:311

`Static`setRouteSkipHasRole

setRouteSkipHasRole(
    controller: Function,
    data: object,
    controllerMethod: string,
): void
Parameters
- controller: Function
- data: object
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:263

`Static`setRouteSkipIsLoggedIn

setRouteSkipIsLoggedIn(
    controller: Function,
    data: object,
    controllerMethod: string,
): void
Parameters
- controller: Function
- data: object
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:222

`Static`setRouteSkipIsNotLoggedIn

setRouteSkipIsNotLoggedIn(
    controller: Function,
    data: object,
    controllerMethod: string,
): void
Parameters
- controller: Function
- data: object
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:455

`Static`setRouteSkipRequire2fa

setRouteSkipRequire2fa(
    controller: Function,
    data: object,
    controllerMethod: string,
): void
Parameters
- controller: Function
- data: object
- controllerMethod: string
Returns void
- Defined in src/utilities/metadata.utilities.ts:359

`Static`setWebsocketController

setWebsocketController(
controller: Function,
data: WebsocketControllerData,
): void
Parameters
- controller: Function
- data: WebsocketControllerData
Returns void
- Defined in src/utilities/metadata.utilities.ts:484

`Static`setWebsocketControllerRoutes

setWebsocketControllerRoutes(
controller: Function,
routes: WebsocketControllerRouteConfiguration[],
): void
Parameters
- controller: Function
- routes: WebsocketControllerRouteConfiguration[]
Returns void
- Defined in src/utilities/metadata.utilities.ts:493