Class ControllerInstance

Represents an instance of a controller, which can be used to handle requests.

Hierarchy

ControllerInstance

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ControllerInstance(server: WebServer, type: Function, injector: Injector, routeTable: any[], context?: ControllerContext, isModule?: boolean): ControllerInstance

- Defined in packages/web-server/src/controller.ts:19
Parameters
- server: WebServer
- type: Function
- injector: Injector
- routeTable: any[]
- Optional context: ControllerContext
- Default value isModule: boolean = false
Returns ControllerInstance

Properties

Readonly injector

injector: Injector

Readonly isModule

isModule: boolean

resolvedMiddleware

resolvedMiddleware: express.RequestHandler[]

Readonly routeTable

routeTable: any[]

Readonly server

server: WebServer

Readonly type

type: Function

Accessors

context

get context(): ControllerContext

- Defined in packages/web-server/src/controller.ts:58
Returns ControllerContext

controllers

get controllers(): ControllerInstance[]

- Defined in packages/web-server/src/controller.ts:167
Returns ControllerInstance[]

group

get group(): string

- Defined in packages/web-server/src/controller.ts:177
Returns string

instance

get instance(): any

- Defined in packages/web-server/src/controller.ts:34
Returns any

middleware

get middleware(): (Function | RequestHandler<ParamsDictionary, any, any, ParsedQs> | [string, RequestHandler<ParamsDictionary, any, any, ParsedQs>])[]

- Defined in packages/web-server/src/controller.ts:62
Returns (Function | RequestHandler<ParamsDictionary, any, any, ParsedQs> | [string, RequestHandler<ParamsDictionary, any, any, ParsedQs>])[]

options

get options(): ControllerOptions

- Defined in packages/web-server/src/controller.ts:173
Returns ControllerOptions

pathPrefix

get pathPrefix(): string

- Defined in packages/web-server/src/controller.ts:157
Returns string

routes

get routes(): RouteInstance[]

- Defined in packages/web-server/src/controller.ts:161
Returns RouteInstance[]

Methods

combinePaths

combinePaths(...paths: any[]): string

- Defined in packages/web-server/src/controller.ts:70
Parameters
- Rest ...paths: any[]
Returns string

initialize

initialize(): void

- Defined in packages/web-server/src/controller.ts:214
Returns void

mount

mount(webServer: WebServer): void

- Defined in packages/web-server/src/controller.ts:229
Parameters
- webServer: WebServer
Returns void

start

start(): void

- Defined in packages/web-server/src/controller.ts:219
Returns void

stop

stop(): void

- Defined in packages/web-server/src/controller.ts:224
Returns void

Generated using TypeDoc