Class WebServer

Implements a web server which is comprised of a set of Controllers.

Hierarchy

WebServer

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new WebServer(injector: Injector, options: WebServerOptions, logger: Logger, appOptions?: ApplicationOptions): WebServer

- Defined in packages/web-server/src/web-server.ts:21
Parameters
- injector: Injector
- options: WebServerOptions
- logger: Logger
- Default value appOptions: ApplicationOptions = {}
Returns WebServer

Properties

Readonly appOptions

appOptions: ApplicationOptions

Readonly logger

logger: Logger

Readonly options

options: WebServerOptions

Readonly websockets

websockets: ws.Server

Accessors

engine

get engine(): WebServerEngine

- Defined in packages/web-server/src/web-server.ts:55
Returns WebServerEngine

injector

get injector(): Injector

- Defined in packages/web-server/src/web-server.ts:131
Returns Injector

serviceDescription

get serviceDescription(): ServiceDescription

- Defined in packages/web-server/src/web-server.ts:139
Returns ServiceDescription

Methods

addRoute

addRoute(definition: RouteDescription, method: string, path: string, handler: (event: WebEvent) => void, middleware?: any[]): void

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

Parameters
- definition: RouteDescription
- method: string
- path: string
- handler: (event: WebEvent) => void
  - - (event: WebEvent): void
    - Parameters
      - event: WebEvent
      Returns void
- Default value middleware: any[] = []
Returns void

handleError

handleError(error: any, event: WebEvent, route: RouteInstance, source: string): void

- Defined in packages/web-server/src/web-server.ts:237
Parameters
- error: any
- event: WebEvent
- route: RouteInstance
- source: string
Returns void

reportRequest

reportRequest(event: WebEvent, source: string): void

- Defined in packages/web-server/src/web-server.ts:166
Parameters
- event: WebEvent
- source: string
Returns void

start

start(): Promise<void>

- Defined in packages/web-server/src/web-server.ts:155
Returns Promise<void>

startConduit

startConduit(): Promise<WebConduit>

- Defined in packages/web-server/src/web-server.ts:187
Returns Promise<WebConduit>

startSocket

startSocket(): Promise<WebSocket>

- Defined in packages/web-server/src/web-server.ts:191
Returns Promise<WebSocket>

stop

stop(): void

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

Static bootstrapCloudFunction

bootstrapCloudFunction(entryModule: any, options?: ApplicationOptions): any

- Defined in packages/web-server/src/web-server.ts:69
Parameters
- entryModule: any
- Optional options: ApplicationOptions
Returns any

Static for

for(webService: any): WebServer

- Defined in packages/web-server/src/web-server.ts:61
Parameters
- webService: any
Returns WebServer

Static register

register(webService: any, server: WebServer): void

- Defined in packages/web-server/src/web-server.ts:65
Parameters
- webService: any
- server: WebServer
Returns void

Static startConduit

startConduit(): Promise<WebConduit>

- Defined in packages/web-server/src/web-server.ts:218
Returns Promise<WebConduit>

Static startSocket

startSocket(): Promise<WebSocket>

- Defined in packages/web-server/src/web-server.ts:214
Returns Promise<WebSocket>

Generated using TypeDoc