Class RouterExplorer

Hierarchy

RouterExplorer

Constructors

constructor

new RouterExplorer(metadataScanner: MetadataScanner, container: NestContainer, injector?: Injector, routerProxy?: RouterProxy, exceptionsFilter?: ExceptionsFilter, config?: ApplicationConfig): RouterExplorer

- Defined in packages/core/router/router-explorer.ts:49
Parameters
- metadataScanner: MetadataScanner
- container: NestContainer
- Optional injector: Injector
- Optional routerProxy: RouterProxy
- Optional exceptionsFilter: ExceptionsFilter
- Optional config: ApplicationConfig
Returns RouterExplorer

Properties

Private Readonly container

container: NestContainer

Private Readonly exceptionFiltersCache

exceptionFiltersCache: WeakMap<object, any> = new WeakMap()

Private Optional Readonly exceptionsFilter

exceptionsFilter: ExceptionsFilter

Private Readonly executionContextCreator

executionContextCreator: RouterExecutionContext

Private Optional Readonly injector

injector: Injector

Private Readonly logger

logger: Logger = new Logger(RouterExplorer.name, true)

Private Readonly metadataScanner

metadataScanner: MetadataScanner

Private Readonly routerMethodFactory

routerMethodFactory: RouterMethodFactory = new RouterMethodFactory()

Private Optional Readonly routerProxy

routerProxy: RouterProxy

Methods

Private applyCallbackToRouter

applyCallbackToRouter<T>(router: T, pathProperties: RoutePathProperties, instanceWrapper: InstanceWrapper, moduleKey: string, basePath: string, host: string): void

- Defined in packages/core/router/router-explorer.ts:176
Type parameters
- T: HttpServer
Parameters
- router: T
- pathProperties: RoutePathProperties
- instanceWrapper: InstanceWrapper
- moduleKey: string
- basePath: string
- host: string
Returns void

Private applyHostFilter

applyHostFilter(host: string, handler: Function): Function

- Defined in packages/core/router/router-explorer.ts:219
Parameters
- host: string
- handler: Function
Returns Function

applyPathsToRouterProxy

applyPathsToRouterProxy<T>(router: T, routePaths: RoutePathProperties[], instanceWrapper: InstanceWrapper, moduleKey: string, basePath: string, host: string): void

- Defined in packages/core/router/router-explorer.ts:147
Type parameters
- T: HttpServer
Parameters
- router: T
- routePaths: RoutePathProperties[]
- instanceWrapper: InstanceWrapper
- moduleKey: string
- basePath: string
- host: string
Returns void

Private createCallbackProxy

createCallbackProxy(instance: Controller, callback: RouterProxyCallback, methodName: string, moduleRef: string, requestMethod: RequestMethod, contextId?: ContextId, inquirerId?: string): (Anonymous function)

- Defined in packages/core/router/router-explorer.ts:249
Parameters
- instance: Controller
- callback: RouterProxyCallback
- methodName: string
- moduleRef: string
- requestMethod: RequestMethod
- Default value contextId: ContextId = STATIC_CONTEXT
- Optional inquirerId: string
Returns (Anonymous function)

createRequestScopedHandler

createRequestScopedHandler(instanceWrapper: InstanceWrapper, requestMethod: RequestMethod, moduleRef: Module, moduleKey: string, methodName: string): (Anonymous function)

- Defined in packages/core/router/router-explorer.ts:277
Parameters
- instanceWrapper: InstanceWrapper
- requestMethod: RequestMethod
- moduleRef: Module
- moduleKey: string
- methodName: string
Returns (Anonymous function)

explore

explore<T>(instanceWrapper: InstanceWrapper, module: string, applicationRef: T, basePath: string, host: string): void

- Defined in packages/core/router/router-explorer.ts:71
Type parameters
- T: HttpServer = any
Parameters
- instanceWrapper: InstanceWrapper
- module: string
- applicationRef: T
- basePath: string
- host: string
Returns void

exploreMethodMetadata

exploreMethodMetadata(instance: Controller, prototype: object, methodName: string): RoutePathProperties

- Defined in packages/core/router/router-explorer.ts:122
Parameters
- instance: Controller
- prototype: object
- methodName: string
Returns RoutePathProperties

extractRouterPath

extractRouterPath(metatype: Type<Controller>, prefix?: string): string

- Defined in packages/core/router/router-explorer.ts:90
Parameters
- metatype: Type<Controller>
- Optional prefix: string
Returns string

Private getContextId

getContextId<T>(request: T): ContextId

- Defined in packages/core/router/router-explorer.ts:326
Type parameters
- T: Record<any, unknown> = any
Parameters
- request: T
Returns ContextId

scanForPaths

scanForPaths(instance: Controller, prototype?: object): RoutePathProperties[]

- Defined in packages/core/router/router-explorer.ts:106
Parameters
- instance: Controller
- Optional prototype: object
Returns RoutePathProperties[]

stripEndSlash

stripEndSlash(str: string): string

- Defined in packages/core/router/router-explorer.ts:172
Parameters
- str: string
Returns string

validateRoutePath

validateRoutePath(path: string): string

- Defined in packages/core/router/router-explorer.ts:99
Parameters
- path: string
Returns string

Generated using TypeDoc