Class RejectWebSocketHandlerDefinition

Hierarchy

Serializable
- RejectWebSocketHandlerDefinition
  - RejectWebSocketHandler

Implements

WebSocketHandlerDefinition

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RejectWebSocketHandlerDefinition(statusCode: number, statusMessage?: string, headers?: Headers, body?: string | Buffer): RejectWebSocketHandlerDefinition

Overrides Serializable.constructor
- Defined in src/rules/websockets/websocket-handler-definitions.ts:161
Parameters
- statusCode: number
- statusMessage: string = 'WebSocket rejected'
- headers: Headers = {}
- body: string | Buffer = ''
Returns RejectWebSocketHandlerDefinition

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

Implementation of WebSocketHandlerDefinition.dispose
Inherited from Serializable.dispose
- Defined in src/serialization/serialization.ts:96
Returns void

explain

explain(): string

Implementation of WebSocketHandlerDefinition.explain
- Defined in src/rules/websockets/websocket-handler-definitions.ts:170
Returns string

Generated using TypeDoc