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>,
): undefined | BackupResourceMetadata
Parameters
- entity: Newable<BackupResourceInterface>
Returns undefined | BackupResourceMetadata
- Defined in src/utilities/metadata.utilities.ts:425

`Static`getControllerBaseRoute

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

`Static`getControllerBelongsTo

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

`Static`getControllerHasRole

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

`Static`getControllerIsLoggedIn

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

`Static`getControllerIsNotLoggedIn

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

`Static`getControllerRequire2fa

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

`Static`getControllerRoutes

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

`Static`getControllerSkipBelongsTo

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

`Static`getControllerSkipHasRole

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

`Static`getControllerSkipIsLoggedIn

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

`Static`getControllerSkipIsNotLoggedIn

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

`Static`getControllerSkipRequire2fa

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

`Static`getEntityMetadata

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

`Static`getFilePath

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

`Static`getInjectParamTokens

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

`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:394

`Static`getParamTypes

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

`Static`getRouteBelongsTo

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

`Static`getRouteBody

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

`Static`getRouteCurrentUser

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

`Static`getRouteCurrentWebsocketConnection

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

`Static`getRouteHasRole

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

`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:164

`Static`getRouteIsLoggedIn

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

`Static`getRouteIsNotLoggedIn

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

`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:140

`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:152

`Static`getRouteRequire2fa

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

`Static`getRouteResponses

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

`Static`getRouteSkipAuth

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

`Static`getRouteSkipBelongsTo

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

`Static`getRouteSkipHasRole

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

`Static`getRouteSkipIsLoggedIn

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

`Static`getRouteSkipIsNotLoggedIn

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

`Static`getRouteSkipRequire2fa

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

`Static`getWebsocketController

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

`Static`getWebsocketControllerRoutes

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

`Static`setBackupResourceMetadata

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

`Static`setControllerBaseRoute

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

`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:310

`Static`setControllerHasRole

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

`Static`setControllerIsLoggedIn

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

`Static`setControllerIsNotLoggedIn

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

`Static`setControllerRequire2fa

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

`Static`setControllerRoutes

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

`Static`setControllerSkipBelongsTo

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

`Static`setControllerSkipHasRole

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

`Static`setControllerSkipIsLoggedIn

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

`Static`setControllerSkipIsNotLoggedIn

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

`Static`setControllerSkipRequire2fa

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

`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:92

`Static`setEntityMetadata

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

`Static`setFilePath

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

`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:96

`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:389

`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:279

`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:172

`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:184

`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:489

`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:238

`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:160

`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:197

`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:430

`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:136

`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:148

`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:327

`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:114

`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:376

`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:298

`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:250

`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:209

`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:442

`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:346

`Static`setWebsocketController

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

`Static`setWebsocketControllerRoutes

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