Class RejectWebSocketHandlerDefinition

Hierarchy (view full)

Serializable
- RejectWebSocketHandlerDefinition
  - RejectWebSocketHandler

Implements

WebSocketHandlerDefinition

Index

Constructors

Properties

body headers statusCode statusMessage type

Methods

dispose explain

Constructors

constructor

new RejectWebSocketHandlerDefinition(statusCode, statusMessage?, headers?, body?): RejectWebSocketHandlerDefinition
Parameters
- statusCode: number
- statusMessage: string = 'WebSocket rejected'
- headers: Headers = {}
- body: string | Buffer = ''
Returns RejectWebSocketHandlerDefinition
Overrides Serializable.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
Implementation of WebSocketHandlerDefinition.dispose
Inherited from Serializable.dispose
- Defined in serialization/serialization.ts:96

explain

explain(): string
Returns string
Implementation of WebSocketHandlerDefinition.explain
- Defined in rules/websockets/websocket-handler-definitions.ts:174