Class RejectWebSocketStep

The definition of a websocket rule step, which can be passed to Mockttp to define a rule.

Implementation of the step is not included in the definition classes, but instead exists in an *Impl class defined separately and used internally.

Hierarchy (View Summary)

Serializable
- RejectWebSocketStep

Implements

WebSocketStepDefinition

Index

Constructors

Properties

body headers statusCode statusMessage type isFinal

Methods

dispose explain

Constructors

constructor

new RejectWebSocketStep(
    statusCode: number,
    statusMessage?: string,
    headers?: Headers,
    body?: string | Buffer<ArrayBufferLike>,
): RejectWebSocketStep
Parameters
- statusCode: number
- statusMessage: string = 'WebSocket rejected'
- headers: Headers = {}
- body: string | Buffer<ArrayBufferLike> = ''
Returns RejectWebSocketStep
Overrides Serializable.constructor
- Defined in rules/websockets/websocket-step-definitions.ts:244

Properties

`Readonly`body

body: string | Buffer<ArrayBufferLike> = ''

`Readonly`headers

headers: Headers = {}

`Readonly`statusCode

statusCode: number

`Readonly`statusMessage

statusMessage: string = 'WebSocket rejected'

`Readonly`type

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

`Static` `Readonly`isFinal

isFinal: true

Methods

dispose

dispose(): void
Returns void
Implementation of WebSocketStepDefinition.dispose

Inherited from Serializable.dispose
- Defined in serialization/serialization.ts:98

explain

explain(): string
Returns string
Implementation of WebSocketStepDefinition.explain
- Defined in rules/websockets/websocket-step-definitions.ts:253