Search
Preparing search index...
The search index is not available
@nestjs/common
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
RouterExplorer
Class RouterExplorer
Hierarchy
RouterExplorer
Index
Constructors
constructor
Properties
container
exceptions
Filter
execution
Context
Creator
injector
logger
metadata
Scanner
router
Method
Factory
router
Proxy
Methods
apply
Callback
ToRouter
apply
Paths
ToRouter
Proxy
create
Callback
Proxy
explore
explore
Method
Metadata
extract
Router
Path
register
Request
Provider
scan
For
Paths
validate
Route
Path
Constructors
constructor
new
Router
Explorer
(
metadataScanner
:
MetadataScanner
, container
:
NestContainer
, injector
?:
Injector
, routerProxy
?:
RouterProxy
, exceptionsFilter
?:
ExceptionsFilter
, config
?:
ApplicationConfig
)
:
RouterExplorer
Parameters
metadataScanner:
MetadataScanner
container:
NestContainer
Optional
injector:
Injector
Optional
routerProxy:
RouterProxy
Optional
exceptionsFilter:
ExceptionsFilter
Optional
config:
ApplicationConfig
Returns
RouterExplorer
Properties
Private
container
container
:
NestContainer
Private
Optional
exceptions
Filter
exceptions
Filter
:
ExceptionsFilter
Private
execution
Context
Creator
execution
Context
Creator
:
RouterExecutionContext
Private
Optional
injector
injector
:
Injector
Private
logger
logger
:
any
= new Logger(RouterExplorer.name, true)
Private
metadata
Scanner
metadata
Scanner
:
MetadataScanner
Private
router
Method
Factory
router
Method
Factory
:
RouterMethodFactory
= new RouterMethodFactory()
Private
Optional
router
Proxy
router
Proxy
:
RouterProxy
Methods
Private
apply
Callback
ToRouter
apply
Callback
ToRouter<T>
(
router
:
T
, pathProperties
:
RoutePathProperties
, instanceWrapper
:
InstanceWrapper
, moduleKey
:
string
, basePath
:
string
)
:
void
Type parameters
T
:
HttpServer
Parameters
router:
T
pathProperties:
RoutePathProperties
instanceWrapper:
InstanceWrapper
moduleKey:
string
basePath:
string
Returns
void
apply
Paths
ToRouter
Proxy
apply
Paths
ToRouter
Proxy<T>
(
router
:
T
, routePaths
:
RoutePathProperties
[]
, instanceWrapper
:
InstanceWrapper
, module
:
string
, basePath
:
string
)
:
void
Type parameters
T
:
HttpServer
Parameters
router:
T
routePaths:
RoutePathProperties
[]
instanceWrapper:
InstanceWrapper
module:
string
basePath:
string
Returns
void
Private
create
Callback
Proxy
create
Callback
Proxy
(
instance
:
Controller
, callback
:
RouterProxyCallback
, methodName
:
string
, module
:
string
, requestMethod
:
RequestMethod
, contextId
?:
ContextId
, inquirerId
?:
string
)
:
(Anonymous function)
Parameters
instance:
Controller
callback:
RouterProxyCallback
methodName:
string
module:
string
requestMethod:
RequestMethod
Default value
contextId:
ContextId
= STATIC_CONTEXT
Optional
inquirerId:
string
Returns
(Anonymous function)
explore
explore<T>
(
instanceWrapper
:
InstanceWrapper
, module
:
string
, applicationRef
:
T
, basePath
:
string
)
:
void
Type parameters
T
:
HttpServer
Parameters
instanceWrapper:
InstanceWrapper
module:
string
applicationRef:
T
basePath:
string
Returns
void
explore
Method
Metadata
explore
Method
Metadata
(
instance
:
Controller
, instancePrototype
:
any
, methodName
:
string
)
:
RoutePathProperties
Parameters
instance:
Controller
instancePrototype:
any
methodName:
string
Returns
RoutePathProperties
extract
Router
Path
extract
Router
Path
(
metatype
:
Type
<
Controller
>
, prefix
?:
string
)
:
string
Parameters
metatype:
Type
<
Controller
>
Optional
prefix:
string
Returns
string
Private
register
Request
Provider
register
Request
Provider<T>
(
request
:
T
, contextId
:
ContextId
)
:
void
Type parameters
T
Parameters
request:
T
contextId:
ContextId
Returns
void
scan
For
Paths
scan
For
Paths
(
instance
:
Controller
, prototype
?:
any
)
:
RoutePathProperties
[]
Parameters
instance:
Controller
Optional
prototype:
any
Returns
RoutePathProperties
[]
validate
Route
Path
validate
Route
Path
(
path
:
string
)
:
string
Parameters
path:
string
Returns
string
Globals
Router
Explorer
constructor
container
exceptions
Filter
execution
Context
Creator
injector
logger
metadata
Scanner
router
Method
Factory
router
Proxy
apply
Callback
ToRouter
apply
Paths
ToRouter
Proxy
create
Callback
Proxy
explore
explore
Method
Metadata
extract
Router
Path
register
Request
Provider
scan
For
Paths
validate
Route
Path
Generated using
TypeDoc