Class RejectWebSocketHandler

Hierarchy (view full)

RejectWebSocketHandlerDefinition
- RejectWebSocketHandler

Index

Constructors

Properties

body headers statusCode statusMessage type

Methods

dispose explain handle

Constructors

constructor

new RejectWebSocketHandler(statusCode, statusMessage?, headers?, body?): RejectWebSocketHandler
Parameters
- statusCode: number
- statusMessage: string = 'WebSocket rejected'
- headers: Headers = {}
- body: string | Buffer = ''
Returns RejectWebSocketHandler
Inherited from RejectWebSocketHandlerDefinition.constructor
- Defined in rules/websockets/websocket-handler-definitions.ts:165

Properties

`Readonly`body

body: string | Buffer = ''

`Readonly`headers

headers: Headers = {}

`Readonly`statusCode

statusCode: number

`Readonly`statusMessage

statusMessage: string = 'WebSocket rejected'

`Readonly`type

type: "ws-reject" = 'ws-reject'

Methods

dispose

dispose(): void
Returns void
Inherited from RejectWebSocketHandlerDefinition.dispose
- Defined in serialization/serialization.ts:96

explain

explain(): string
Returns string
Inherited from RejectWebSocketHandlerDefinition.explain
- Defined in rules/websockets/websocket-handler-definitions.ts:174

handle

handle(req, socket, head): Promise<void>
Parameters
- req: OngoingRequest
- socket: Socket
- head: Buffer
Returns Promise<void>
- Defined in rules/websockets/websocket-handlers.ts:484