Search
Preparing search index...
The search index is not available
@nestjs/core
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
RouterExecutionContext
Class RouterExecutionContext
Hierarchy
RouterExecutionContext
Index
Constructors
constructor
Properties
application
Ref
context
Utils
guards
Consumer
guards
Context
Creator
handler
Metadata
Storage
interceptors
Consumer
interceptors
Context
Creator
params
Factory
pipes
Consumer
pipes
Context
Creator
response
Controller
Methods
create
create
Guards
Fn
create
Handle
Response
Fn
create
Pipes
Fn
exchange
Keys
For
Values
get
Metadata
get
Param
Value
is
Pipeable
is
Response
Handled
reflect
Http
Status
Code
reflect
Redirect
reflect
Render
Template
reflect
Response
Headers
reflect
Sse
Constructors
constructor
new
Router
Execution
Context
(
paramsFactory
:
IRouteParamsFactory
, pipesContextCreator
:
PipesContextCreator
, pipesConsumer
:
PipesConsumer
, guardsContextCreator
:
GuardsContextCreator
, guardsConsumer
:
GuardsConsumer
, interceptorsContextCreator
:
InterceptorsContextCreator
, interceptorsConsumer
:
InterceptorsConsumer
, applicationRef
:
HttpServer
)
:
RouterExecutionContext
Parameters
paramsFactory:
IRouteParamsFactory
pipesContextCreator:
PipesContextCreator
pipesConsumer:
PipesConsumer
guardsContextCreator:
GuardsContextCreator
guardsConsumer:
GuardsConsumer
interceptorsContextCreator:
InterceptorsContextCreator
interceptorsConsumer:
InterceptorsConsumer
applicationRef:
HttpServer
Returns
RouterExecutionContext
Properties
Readonly
application
Ref
application
Ref
:
HttpServer
Private
Readonly
context
Utils
context
Utils
:
ContextUtils
= new ContextUtils()
Private
Readonly
guards
Consumer
guards
Consumer
:
GuardsConsumer
Private
Readonly
guards
Context
Creator
guards
Context
Creator
:
GuardsContextCreator
Private
Readonly
handler
Metadata
Storage
handler
Metadata
Storage
:
HandlerMetadataStorage
<
HandlerMetadata
,
any
>
= new HandlerMetadataStorage()
Private
Readonly
interceptors
Consumer
interceptors
Consumer
:
InterceptorsConsumer
Private
Readonly
interceptors
Context
Creator
interceptors
Context
Creator
:
InterceptorsContextCreator
Private
Readonly
params
Factory
params
Factory
:
IRouteParamsFactory
Private
Readonly
pipes
Consumer
pipes
Consumer
:
PipesConsumer
Private
Readonly
pipes
Context
Creator
pipes
Context
Creator
:
PipesContextCreator
Private
Readonly
response
Controller
response
Controller
:
RouterResponseController
Methods
create
create
(
instance
:
Controller
, callback
:
(
...
args
:
any
[]
)
=>
unknown
, methodName
:
string
, moduleKey
:
string
, requestMethod
:
RequestMethod
, contextId
?:
ContextId
, inquirerId
?:
string
)
:
(Anonymous function)
Parameters
instance:
Controller
callback:
(
...
args
:
any
[]
)
=>
unknown
(
...
args
:
any
[]
)
:
unknown
Parameters
Rest
...
args:
any
[]
Returns
unknown
methodName:
string
moduleKey:
string
requestMethod:
RequestMethod
Default value
contextId:
ContextId
= STATIC_CONTEXT
Optional
inquirerId:
string
Returns
(Anonymous function)
create
Guards
Fn
create
Guards
Fn<TContext>
(
guards
:
CanActivate
[]
, instance
:
Controller
, callback
:
(
...
args
:
any
[]
)
=>
any
, contextType
?:
TContext
)
:
(
args
:
any
[]
)
=>
Promise
<
void
>
|
null
Type parameters
TContext
:
string
=
ContextType
Parameters
guards:
CanActivate
[]
instance:
Controller
callback:
(
...
args
:
any
[]
)
=>
any
(
...
args
:
any
[]
)
:
any
Parameters
Rest
...
args:
any
[]
Returns
any
Optional
contextType:
TContext
Returns
(
args
:
any
[]
)
=>
Promise
<
void
>
|
null
(
args
:
any
[]
)
:
Promise
<
void
>
|
null
Parameters
args:
any
[]
Returns
Promise
<
void
>
|
null
create
Handle
Response
Fn
create
Handle
Response
Fn
(
callback
:
(
...
args
:
unknown
[]
)
=>
unknown
, isResponseHandled
:
boolean
, redirectResponse
?:
RedirectResponse
, httpStatusCode
?:
number
)
:
HandleResponseFn
Parameters
callback:
(
...
args
:
unknown
[]
)
=>
unknown
(
...
args
:
unknown
[]
)
:
unknown
Parameters
Rest
...
args:
unknown
[]
Returns
unknown
isResponseHandled:
boolean
Optional
redirectResponse:
RedirectResponse
Optional
httpStatusCode:
number
Returns
HandleResponseFn
create
Pipes
Fn
create
Pipes
Fn
(
pipes
:
PipeTransform
[]
, paramsOptions
:
(
ParamProperties
&
{
metatype
?:
any
}
)
[]
)
:
pipesFn
Parameters
pipes:
PipeTransform
[]
paramsOptions:
(
ParamProperties
&
{
metatype
?:
any
}
)
[]
Returns
pipesFn
exchange
Keys
For
Values
exchange
Keys
For
Values
(
keys
:
string
[]
, metadata
:
Record
<
number
,
RouteParamMetadata
>
, moduleContext
:
string
, contextId
?:
ContextId
, inquirerId
?:
string
, contextFactory
?:
(
args
:
unknown
[]
)
=>
ExecutionContextHost
)
:
ParamProperties
[]
Parameters
keys:
string
[]
metadata:
Record
<
number
,
RouteParamMetadata
>
moduleContext:
string
Default value
contextId:
ContextId
= STATIC_CONTEXT
Optional
inquirerId:
string
Optional
contextFactory:
(
args
:
unknown
[]
)
=>
ExecutionContextHost
(
args
:
unknown
[]
)
:
ExecutionContextHost
Parameters
args:
unknown
[]
Returns
ExecutionContextHost
Returns
ParamProperties
[]
get
Metadata
get
Metadata<TContext>
(
instance
:
Controller
, callback
:
(
...
args
:
any
[]
)
=>
any
, methodName
:
string
, moduleKey
:
string
, requestMethod
:
RequestMethod
, contextType
:
TContext
)
:
HandlerMetadata
Type parameters
TContext
:
ContextType
=
ContextType
Parameters
instance:
Controller
callback:
(
...
args
:
any
[]
)
=>
any
(
...
args
:
any
[]
)
:
any
Parameters
Rest
...
args:
any
[]
Returns
any
methodName:
string
moduleKey:
string
requestMethod:
RequestMethod
contextType:
TContext
Returns
HandlerMetadata
get
Param
Value
get
Param
Value<T>
(
value
:
T
, __namedParameters
:
{
data
:
unknown
;
metatype
:
unknown
;
type
:
RouteParamtypes
}
, pipes
:
PipeTransform
[]
)
:
Promise
<
unknown
>
Type parameters
T
Parameters
value:
T
__namedParameters:
{
data
:
unknown
;
metatype
:
unknown
;
type
:
RouteParamtypes
}
data
:
unknown
metatype
:
unknown
type
:
RouteParamtypes
pipes:
PipeTransform
[]
Returns
Promise
<
unknown
>
is
Pipeable
is
Pipeable
(
type
:
number
|
string
)
:
boolean
Parameters
type:
number
|
string
Returns
boolean
Private
is
Response
Handled
is
Response
Handled
(
instance
:
Controller
, methodName
:
string
, paramsMetadata
:
ParamProperties
[]
)
:
boolean
Parameters
instance:
Controller
methodName:
string
paramsMetadata:
ParamProperties
[]
Returns
boolean
reflect
Http
Status
Code
reflect
Http
Status
Code
(
callback
:
(
...
args
:
unknown
[]
)
=>
unknown
)
:
number
Parameters
callback:
(
...
args
:
unknown
[]
)
=>
unknown
(
...
args
:
unknown
[]
)
:
unknown
Parameters
Rest
...
args:
unknown
[]
Returns
unknown
Returns
number
reflect
Redirect
reflect
Redirect
(
callback
:
(
...
args
:
unknown
[]
)
=>
unknown
)
:
RedirectResponse
Parameters
callback:
(
...
args
:
unknown
[]
)
=>
unknown
(
...
args
:
unknown
[]
)
:
unknown
Parameters
Rest
...
args:
unknown
[]
Returns
unknown
Returns
RedirectResponse
reflect
Render
Template
reflect
Render
Template
(
callback
:
(
...
args
:
unknown
[]
)
=>
unknown
)
:
string
Parameters
callback:
(
...
args
:
unknown
[]
)
=>
unknown
(
...
args
:
unknown
[]
)
:
unknown
Parameters
Rest
...
args:
unknown
[]
Returns
unknown
Returns
string
reflect
Response
Headers
reflect
Response
Headers
(
callback
:
(
...
args
:
unknown
[]
)
=>
unknown
)
:
CustomHeader
[]
Parameters
callback:
(
...
args
:
unknown
[]
)
=>
unknown
(
...
args
:
unknown
[]
)
:
unknown
Parameters
Rest
...
args:
unknown
[]
Returns
unknown
Returns
CustomHeader
[]
reflect
Sse
reflect
Sse
(
callback
:
(
...
args
:
unknown
[]
)
=>
unknown
)
:
string
Parameters
callback:
(
...
args
:
unknown
[]
)
=>
unknown
(
...
args
:
unknown
[]
)
:
unknown
Parameters
Rest
...
args:
unknown
[]
Returns
unknown
Returns
string
Globals
Router
Execution
Context
constructor
application
Ref
context
Utils
guards
Consumer
guards
Context
Creator
handler
Metadata
Storage
interceptors
Consumer
interceptors
Context
Creator
params
Factory
pipes
Consumer
pipes
Context
Creator
response
Controller
create
create
Guards
Fn
create
Handle
Response
Fn
create
Pipes
Fn
exchange
Keys
For
Values
get
Metadata
get
Param
Value
is
Pipeable
is
Response
Handled
reflect
Http
Status
Code
reflect
Redirect
reflect
Render
Template
reflect
Response
Headers
reflect
Sse
Generated using
TypeDoc