Class WebEvent

Represents

Hierarchy

WebEvent

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new WebEvent(request: express.Request, response: express.Response): WebEvent

- Defined in packages/web-server/src/metadata/route-event.ts:13
Parameters
- request: express.Request
- response: express.Response
Returns WebEvent

Properties

connected

connected: boolean = true

Is the client still connected?

controller

controller: any

request

request: express.Request

response

response: express.Response

Accessors

Static connected

get connected(): boolean

- Defined in packages/web-server/src/metadata/route-event.ts:95
Is the client still connected?

Returns boolean

Static controller

get controller(): any

- Defined in packages/web-server/src/metadata/route-event.ts:47
Returns any

Static current

get current(): WebEvent

- Defined in packages/web-server/src/metadata/route-event.ts:31
Returns WebEvent

Static request

get request(): Request<ParamsDictionary, any, any, ParsedQs>

- Defined in packages/web-server/src/metadata/route-event.ts:39
Returns Request<ParamsDictionary, any, any, ParsedQs>

Static response

get response(): Response<any>

- Defined in packages/web-server/src/metadata/route-event.ts:43
Returns Response<any>

Methods

context

context<T>(callback: () => T): T

- Defined in packages/web-server/src/metadata/route-event.ts:35
Type parameters
- T
Parameters
- callback: () => T
  - - (): T
    - Returns T
Returns T

sendEvent

sendEvent(event: ServerSentEvent): Promise<void>

- Defined in packages/web-server/src/metadata/route-event.ts:55
Send a server-sent-event to the client as part of a "text/event-stream" response

Parameters
- event: ServerSentEvent
Returns Promise<void>

Static sendEvent

sendEvent(event: ServerSentEvent): Promise<void>

- Defined in packages/web-server/src/metadata/route-event.ts:88
Parameters
- event: ServerSentEvent
Returns Promise<void>

Static with

with<T>(routeEvent: WebEvent, callback: () => T): T

- Defined in packages/web-server/src/metadata/route-event.ts:99
Type parameters
- T
Parameters
- routeEvent: WebEvent
- callback: () => T
  - - (): T
    - Returns T
Returns T

Generated using TypeDoc