API reference › @evolu/common › WebSocket › TestCreateWebSocket
Defined in: packages/common/src/WebSocket.ts:775
An inspectable in-memory CreateWebSocket for testing by testCreateWebSocket.
Sockets report the states createWebSocket reports, including the
connecting a socket is in before it opens and while the wrapper retries
after a close or a WebSocket.reconnect. While it retries,
WebSocket.reconnect does nothing, as the wrapper has no socket until
TestCreateWebSocket.open. Only disposal ends in closed. The
closing state is not modeled: no helper starts a close handshake. The event
helpers throw for a disposed socket, which cannot receive events:
createWebSocket detaches its handlers on disposal.
Extends
TestCreateWebSocket(url: string, options?: WebSocketOptions): Task<WebSocket>;
Defined in: packages/common/src/WebSocket.ts:775
An inspectable in-memory CreateWebSocket for testing by testCreateWebSocket.
Sockets report the states createWebSocket reports, including the
connecting a socket is in before it opens and while the wrapper retries
after a close or a WebSocket.reconnect. While it retries,
WebSocket.reconnect does nothing, as the wrapper has no socket until
TestCreateWebSocket.open. Only disposal ends in closed. The
closing state is not modeled: no helper starts a close handshake. The event
helpers throw for a disposed socket, which cannot receive events:
createWebSocket detaches its handlers on disposal.
Properties
close
readonly close: (url: string, event?: Partial<WebSocketCloseEvent>) => void;
Defined in: packages/common/src/WebSocket.ts:789
Reports the close event, with code defaulting to 1006, and leaves the
socket connecting.
createdUrls
readonly createdUrls: string[];
Defined in: packages/common/src/WebSocket.ts:776
error
readonly error: (url: string, error: WebSocketError) => void;
Defined in: packages/common/src/WebSocket.ts:790
message
readonly message: (url: string, data:
| string
| ArrayBuffer
| Blob) => void;
Defined in: packages/common/src/WebSocket.ts:783
open
readonly open: (url: string) => void;
Defined in: packages/common/src/WebSocket.ts:784
reconnectedUrls
readonly reconnectedUrls: string[];
Defined in: packages/common/src/WebSocket.ts:778
URLs whose newest socket was reconnected, in call order.
sentMessages
readonly sentMessages: {
data: string | Uint8Array<ArrayBufferLike> | Blob | BufferSource;
url: string;
}[];
Defined in: packages/common/src/WebSocket.ts:779
| Name | Type | Defined in |
|---|---|---|
data | string | Uint8Array<ArrayBufferLike> | Blob | BufferSource | packages/common/src/WebSocket.ts:781 |
url | string | packages/common/src/WebSocket.ts:780 |