RouterExecutionContext | @nestjs/common

Hierarchy

RouterExecutionContext

Constructors

constructor

new RouterExecutionContext(paramsFactory: IRouteParamsFactory, pipesContextCreator: PipesContextCreator, pipesConsumer: PipesConsumer, guardsContextCreator: GuardsContextCreator, guardsConsumer: GuardsConsumer, interceptorsContextCreator: InterceptorsContextCreator, interceptorsConsumer: InterceptorsConsumer, applicationRef: HttpServer): RouterExecutionContext

- Defined in core/router/router-execution-context.ts:57
Parameters
- paramsFactory: IRouteParamsFactory
- pipesContextCreator: PipesContextCreator
- pipesConsumer: PipesConsumer
- guardsContextCreator: GuardsContextCreator
- guardsConsumer: GuardsConsumer
- interceptorsContextCreator: InterceptorsContextCreator
- interceptorsConsumer: InterceptorsConsumer
- applicationRef: HttpServer
Returns RouterExecutionContext

Properties

applicationRef

applicationRef: HttpServer

Private contextUtils

contextUtils: ContextUtils = new ContextUtils()

Private guardsConsumer

guardsConsumer: GuardsConsumer

Private guardsContextCreator

guardsContextCreator: GuardsContextCreator

Private handlerMetadataStorage

handlerMetadataStorage: HandlerMetadataStorage<HandlerMetadata, any> = new HandlerMetadataStorage()

Private interceptorsConsumer

interceptorsConsumer: InterceptorsConsumer

Private interceptorsContextCreator

interceptorsContextCreator: InterceptorsContextCreator

Private paramsFactory

paramsFactory: IRouteParamsFactory

Private pipesConsumer

pipesConsumer: PipesConsumer

Private pipesContextCreator

pipesContextCreator: PipesContextCreator

Private responseController

responseController: RouterResponseController

Methods

create

create(instance: Controller, callback: function, methodName: string, module: string, requestMethod: RequestMethod, contextId?: ContextId, inquirerId?: string): (Anonymous function)

- Defined in core/router/router-execution-context.ts:72
Parameters
- instance: Controller
- callback: function
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
- methodName: string
- module: string
- requestMethod: RequestMethod
- Default value contextId: ContextId = STATIC_CONTEXT
- Optional inquirerId: string
Returns (Anonymous function)

createGuardsFn

createGuardsFn(guards: any[], instance: Controller, callback: function): Function | null

- Defined in core/router/router-execution-context.ts:305
Parameters
- guards: any[]
- instance: Controller
- callback: function
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
Returns Function | null

createHandleResponseFn

createHandleResponseFn(callback: function, isResponseHandled: boolean, httpStatusCode?: number): (Anonymous function)

- Defined in core/router/router-execution-context.ts:357
Parameters
- callback: function
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
- isResponseHandled: boolean
- Optional httpStatusCode: number
Returns (Anonymous function)

createPipesFn

createPipesFn(pipes: any[], paramsOptions: (ParamProperties & object)[]): pipesFn

- Defined in core/router/router-execution-context.ts:324
Parameters
- pipes: any[]
- paramsOptions: (ParamProperties & object)[]
Returns pipesFn

exchangeKeysForValues

exchangeKeysForValues(keys: string[], metadata: RouteParamsMetadata, moduleContext: string, contextId?: ContextId, inquirerId?: string): ParamProperties[]

- Defined in core/router/router-execution-context.ts:235
Parameters
- keys: string[]
- metadata: RouteParamsMetadata
- moduleContext: string
- Default value contextId: ContextId = STATIC_CONTEXT
- Optional inquirerId: string
Returns ParamProperties[]

getCustomFactory

getCustomFactory(factory: function, data: any): function

- Defined in core/router/router-execution-context.ts:272
Parameters
- factory: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
- data: any
Returns function
- - (...args: any[]): any
  - Parameters
    - Rest ...args: any[]
    Returns any

getMetadata

getMetadata(instance: Controller, callback: function, methodName: string, module: string, requestMethod: RequestMethod): HandlerMetadata

- Defined in core/router/router-execution-context.ts:153
Parameters
- instance: Controller
- callback: function
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
- methodName: string
- module: string
- requestMethod: RequestMethod
Returns HandlerMetadata

getParamValue

getParamValue<T>(value: T, __namedParameters: object, transforms: Transform<any>[]): Promise<any>

- Defined in core/router/router-execution-context.ts:281
Type parameters
- T
Parameters
- value: T
- __namedParameters: object
  - data: any
  - metatype: any
  - type: any
- transforms: Transform<any>[]
Returns Promise<any>

reflectHttpStatusCode

reflectHttpStatusCode(callback: function): number

- Defined in core/router/router-execution-context.ts:221
Parameters
- callback: function
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
Returns number

reflectRenderTemplate

reflectRenderTemplate(callback: function): string

- Defined in core/router/router-execution-context.ts:225
Parameters
- callback: function
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
Returns string

reflectResponseHeaders

reflectResponseHeaders(callback: function): CustomHeader[]

- Defined in core/router/router-execution-context.ts:229
Parameters
- callback: function
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
Returns CustomHeader[]

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

paramsFactory: IRouteParamsFactory

pipesContextCreator: PipesContextCreator

pipesConsumer: PipesConsumer

guardsContextCreator: GuardsContextCreator

guardsConsumer: GuardsConsumer

interceptorsContextCreator: InterceptorsContextCreator

interceptorsConsumer: InterceptorsConsumer

applicationRef: HttpServer

Returns RouterExecutionContext

Properties

applicationRef

Private contextUtils

Private guardsConsumer

Private guardsContextCreator

Private handlerMetadataStorage

Private interceptorsConsumer

Private interceptorsContextCreator

Private paramsFactory

Private pipesConsumer

Private pipesContextCreator

Private responseController

Methods

create

Parameters

instance: Controller

callback: function

Parameters

Rest ...args: any[]

Returns any

methodName: string

module: string

requestMethod: RequestMethod

Default value contextId: ContextId = STATIC_CONTEXT

Optional inquirerId: string

Returns (Anonymous function)

createGuardsFn

Parameters

guards: any[]

instance: Controller

callback: function

Parameters

Rest ...args: any[]

Returns any

Returns Function | null

createHandleResponseFn

Parameters

callback: function

Parameters

Rest ...args: any[]

Returns any

isResponseHandled: boolean

Optional httpStatusCode: number

Returns (Anonymous function)

createPipesFn

Parameters

pipes: any[]

paramsOptions: (ParamProperties & object)[]

Returns pipesFn

exchangeKeysForValues

Parameters

keys: string[]

metadata: RouteParamsMetadata

moduleContext: string

Default value contextId: ContextId = STATIC_CONTEXT

Optional inquirerId: string

Returns ParamProperties[]

getCustomFactory

Parameters

factory: function

Parameters

Rest ...args: any[]

Returns void