Class MockWebSocket

Implement the WebSocket W3C browser API for testing.

Hierarchy

MockWebSocket

Index

Constructors

Properties

_queuedResponses lastRequest readyState requests responses url

Methods

_autoReply close message onclose onmessage onopen open queueResponses reply send

Constructors

constructor

new MockWebSocket(init: ((ws: MockWebSocket) => void), url: string): MockWebSocket
Parameters
- init: ((ws: MockWebSocket) => void)
  - - (ws: MockWebSocket): void
    - Parameters
      
      ws: MockWebSocket
      
      Returns void
- url: string
Returns MockWebSocket
- Defined in api/tests/helpers.ts:180

Properties

_queuedResponses

_queuedResponses: Map<number, Response>

lastRequest

lastRequest: null | Request

readyState

readyState: number

requests

requests: Request[]

responses

responses: any

url

url: string

Methods

_autoReply

_autoReply(requestId: number): void
Parameters
- requestId: number
Returns void
- Defined in api/tests/helpers.ts:218

close

close(reason: string, code?: number, wasClean?: boolean): void
Parameters
- reason: string
- code: number = 1000
- wasClean: boolean = true
Returns void
- Defined in api/tests/helpers.ts:199

message

message(msg: string): void
Parameters
- msg: string
Returns void
- Defined in api/tests/helpers.ts:204

onclose

onclose(_params: {
    code: number;
    reason: string;
    wasClean: boolean;
}): void
Parameters
- _params: {
      code: number;
      reason: string;
      wasClean: boolean;
  }
  - code: number
  - reason: string
  - wasClean: boolean
Returns void
- Defined in api/tests/helpers.ts:191

onmessage

onmessage(_params: {
data: string;
}): void
Parameters
- _params: {
  data: string;
  }
  - data: string
Returns void
- Defined in api/tests/helpers.ts:192

onopen

onopen(): void
Returns void
- Defined in api/tests/helpers.ts:190

open

open(): void
Returns void
- Defined in api/tests/helpers.ts:194

queueResponses

queueResponses(responses: Map<number, Response>): void
Queue up a number of response values for upcoming requests.
Parameters
- responses: Map<number, Response>
  
  The response values as a map where the Id is the request-id and the value is the response value. The response value does not need to include the request-id key.
Returns void
- Defined in api/tests/helpers.ts:250

reply

reply(resp: Response): void
Reply to requests from the WebSocket.
Parameters
- resp: Response
  
  The response for the request in a JSON.stringify-able format.
Returns void
- Defined in api/tests/helpers.ts:233

send

send(msg: string): void
Parameters
- msg: string
Returns void
- Defined in api/tests/helpers.ts:208

Generated using TypeDoc