Class RouteInstance

Represents a Route instance

Hierarchy

RouteInstance

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new RouteInstance(server: WebServer, controllerInstance: any, injector: Injector, parentMiddleware: any[], parentGroup: string, controllerType: Function, routeTable: any[], definition: RouteDefinition): RouteInstance

- Defined in packages/web-server/src/route.ts:204
Parameters
- server: WebServer
- controllerInstance: any
- injector: Injector
- parentMiddleware: any[]
- parentGroup: string
- controllerType: Function
- routeTable: any[]
- definition: RouteDefinition
Returns RouteInstance

Properties

_parameters

_parameters: RouteMethodParameter[] = []

Readonly controllerInstance

controllerInstance: any

Readonly controllerType

controllerType: Function

Readonly definition

definition: RouteDefinition

Readonly injector

injector: Injector

middleware

middleware: any[]

Readonly parentGroup

parentGroup: string

Readonly parentMiddleware

parentMiddleware: any[]

resolvedMiddleware

resolvedMiddleware: any[]

Readonly routeTable

routeTable: any[]

Readonly server

server: WebServer

Accessors

description

get description(): RouteDescription

- Defined in packages/web-server/src/route.ts:281
Returns RouteDescription

group

get group(): string

- Defined in packages/web-server/src/route.ts:246
Returns string

methodMetadata

get methodMetadata(): RouteMethodMetadata

- Defined in packages/web-server/src/route.ts:365
Returns RouteMethodMetadata

options

get options(): RouteOptions

- Defined in packages/web-server/src/route.ts:242
Returns RouteOptions

parameters

get parameters(): RouteMethodParameter<any>[]

- Defined in packages/web-server/src/route.ts:416
Returns RouteMethodParameter<any>[]

params

get params(): string[]

- Defined in packages/web-server/src/route.ts:218
Returns string[]

pathParameterMap

get pathParameterMap(): {}

- Defined in packages/web-server/src/route.ts:252
Returns {}

Methods

logAndExecute

logAndExecute(instance: any, event: WebEvent): Promise<void>

- Defined in packages/web-server/src/route.ts:420
Parameters
- instance: any
- event: WebEvent
Returns Promise<void>

mount

mount(pathPrefix: string): void

- Defined in packages/web-server/src/route.ts:534
Installs this route into the given Express application.

Parameters
- pathPrefix: string
Returns void

Generated using TypeDoc