@auroradao/datastream-connector-ws

Implements the datastream client connector for the ws package by implementing the connector interface.

1interface Connection$Configuration {
2  log: boolean;
3  url: string;
4}
5
6interface Connection$Callback {
7  (event: 'open'): void;
8  (event: 'close', code: number, reason: string, clean: boolean): void;
9  (event: 'error', error: Error): void;
10  (event: 'pong', data: string): void;
11  (event: 'message', data: any): void;
12}
13
14interface Connection$Socket {
15  readonly OPEN: number;
16  readonly CONNECTING: number;
17  readonly CLOSING: number;
18  readonly CLOSED: number;
19
20  readonly readyState: number;
21
22  send(data: any, cb: (err?: Error) => void): void;
23  close(code?: number, reason?: string): void;
24  ping(sid: string): void;
25  terminate(): void;
26}
27
28type Connection$Connector = (
29  config: Connection$Configuration,
30  callback: Connection$Callback
31) => Connection$Socket;