Class HttpServerWebSocketContext

Represents the http-server context for a WebSocket connections.

Handles WebSocket connection lifecycle with duplex streaming support.

Constructors

constructor

new HttpServerWebSocketContext(
    ws: WebSocket,
    req: IncomingMessage,
    state: HttpServerContextState,
): HttpServerWebSocketContext
Creates a new WebSocket context.
Parameters
- ws: WebSocket
  The WebSocket connection.
- req: IncomingMessage
  The server request object.
- state: HttpServerContextState
  The context shared state.
Returns HttpServerWebSocketContext
Overrides HttpServerBaseContext.constructor
- Defined in packages/http-server/src/http-server-context.ts:464

Properties

finishTime

finishTime: number = 0

Timestamp when processing finished.

`Readonly`method

method: HttpMethodWrap

Request method wrapper.

`Readonly`requestBody

requestBody: HttpBodyWrap

Request body wrapper.

`Readonly`requestHeaders

requestHeaders: HttpHeadersWrap

Request headers wrapper.

`Readonly`responseBody

responseBody: HttpBodyWrap

Response body wrapper.

`Readonly`responseHeaders

responseHeaders: HttpHeadersWrap

Response headers wrapper.

`Readonly`startTime

startTime: number = ...

Timestamp when processing started.

`Readonly`state

state: HttpServerContextState

The context shared state.

`Readonly`status

status: HttpStatusWrap

Response status wrapper.

`Readonly`trace

trace: string[] = []

Names of middleware that have already been processed.

`Readonly`type

type: HttpServerContextType

The variant of context type.

`Readonly`url

url: HttpUrlWrap

Request URL wrapper.

Accessors

clientIp

get clientIp(): string | undefined
Parsed client IP address.

Returns string | undefined
Inherited from HttpServerBaseContext.clientIp
- Defined in packages/http-server/src/http-server-context.ts:227

connection

get connection(): HttpConnection
Parsed connection details.

Returns HttpConnection
Inherited from HttpServerBaseContext.connection
- Defined in packages/http-server/src/http-server-context.ts:231

isBot

get isBot(): boolean
Whether the client is identified as a bot.

Returns boolean
Inherited from HttpServerBaseContext.isBot
- Defined in packages/http-server/src/http-server-context.ts:201

isComplete

get isComplete(): boolean
Returns boolean
Overrides HttpServerBaseContext.isComplete
- Defined in packages/http-server/src/http-server-context.ts:513

requestStream

get requestStream(): Readable
Returns Readable
Overrides HttpServerBaseContext.requestStream
- Defined in packages/http-server/src/http-server-context.ts:485

responseStream

get responseStream(): Writable
Returns Writable
Overrides HttpServerBaseContext.responseStream
- Defined in packages/http-server/src/http-server-context.ts:489

userAgent

get userAgent(): IResult
Parsed User-Agent data.

Returns IResult
Inherited from HttpServerBaseContext.userAgent
- Defined in packages/http-server/src/http-server-context.ts:215

Methods

close

close(): void
Returns void
Overrides HttpServerBaseContext.close
- Defined in packages/http-server/src/http-server-context.ts:507

dump

dump(): object
Dumps a serializable representation of a context for logging.

Returns object
A plain object with context details.
Inherited from HttpServerBaseContext.dump
- Defined in packages/http-server/src/http-server-context.ts:244

loadRequest

loadRequest(bodySizeLimit: number): Promise<void>
Parameters
- bodySizeLimit: number
Returns Promise<void>
Overrides HttpServerBaseContext.loadRequest
- Defined in packages/http-server/src/http-server-context.ts:493

sendHead

sendHead(): void
Returns void
Overrides HttpServerBaseContext.sendHead
- Defined in packages/http-server/src/http-server-context.ts:499

sendResponse

sendResponse(): Promise<void>
Returns Promise<void>
Overrides HttpServerBaseContext.sendResponse
- Defined in packages/http-server/src/http-server-context.ts:503

Class HttpServerWebSocketContext

Constructors

constructor

Parameters

Returns HttpServerWebSocketContext

Properties

finishTime

Readonlymethod

ReadonlyrequestBody

ReadonlyrequestHeaders

ReadonlyresponseBody

ReadonlyresponseHeaders

ReadonlystartTime

Readonlystate

Readonlystatus

Readonlytrace

Readonlytype

Readonlyurl