Type Alias: WebSocketStream<T>

WebSocketStream<T> = Stream<T> & object

Defined in: streams/webSocket.ts:9

A stream that represents a WebSocket-like interface. Extends a standard Stream with a .send() method to send messages.

Type Declaration

send()

send: (message) => void

Sends a JSON-serializable message to the WebSocket server.

Parameters

message

T

Returns

void

close()

close: () => void

Close the WebSocket and stop the generator

Returns

void

Type Parameters

T

T = any

The type of messages sent and received.