Class StreamingSocket

A WebSocket wrapper that exposes all events as a stream.

This underlying socket will not be closed when the stream has no listeners

Hierarchy

StreamingSocket

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StreamingSocket(url: string, timeout?: number): StreamingSocket

- Defined in streamingsocket.ts:16
Parameters
- url: string
- timeout: number = 10_000
Returns StreamingSocket

Properties

Readonly connected

connected: Promise<void>

Readonly events

events: Stream<SocketWrapperMessageEvent>

Methods

connect

connect(): void

- Defined in streamingsocket.ts:52
Returns void

disconnect

disconnect(): void

- Defined in streamingsocket.ts:56
Returns void

send

send(data: string): Promise<void>

- Defined in streamingsocket.ts:60
Parameters
- data: string
Returns Promise<void>

Generated using TypeDoc