-
Notifications
You must be signed in to change notification settings - Fork 1
/
ElkConnection.ts
94 lines (81 loc) · 3.34 KB
/
ElkConnection.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
import ElkConnectionState from './ElkConnectionState';
type StateChangeListener = (previousState: ElkConnectionState) => void;
type DisconnectedListener = (previousState: ElkConnectionState, error?: Error) => void;
type ErrorListener = (error: Error) => void;
type DataListener = (data: string) => void;
/**
* A map of connection states to the name of the event that they emit
* when the connection is changed to that state.
*/
export const STATE_CHANGE_EVENT_NAMES: { [P in ElkConnectionState]: string } = {
[ElkConnectionState.Disconnected]: 'disconnected',
[ElkConnectionState.Connecting]: 'connecting',
[ElkConnectionState.Connected]: 'connected',
[ElkConnectionState.Disconnecting]: 'disconnecting',
};
export default interface ElkConnection {
/**
* Emitted whenever the connection state has changed.
* @event
*/
addListener(
event: 'connecting' | 'connected' | 'disconnecting',
listener: StateChangeListener
): this;
/**
* Emitted whenever the connection state has changed.
* @event
*/
addListener(event: 'disconnected', listener: DisconnectedListener): this;
/**
* Emitted whenever an error occurs.
* @event
*/
addListener(event: 'error', listener: ErrorListener): this;
/**
* Emitted whenever data is received.
* @event
*/
addListener(event: 'data', listener: DataListener): this;
removeListener(
event: 'connecting' | 'connected' | 'disconnecting',
listener: StateChangeListener
): this;
removeListener(event: 'disconnected', listener: DisconnectedListener): this;
removeListener(event: 'error', listener: ErrorListener): this;
removeListener(event: 'data', listener: DataListener): this;
on(event: 'connecting' | 'connected' | 'disconnecting', listener: StateChangeListener): this;
on(event: 'disconnected', listener: DisconnectedListener): this;
on(event: 'error', listener: ErrorListener): this;
on(event: 'data', listener: DataListener): this;
once(event: 'connecting' | 'connected' | 'disconnecting', listener: StateChangeListener): this;
once(event: 'disconnected', listener: DisconnectedListener): this;
once(event: 'error', listener: ErrorListener): this;
once(event: 'data', listener: DataListener): this;
prependListener(
event: 'connecting' | 'connected' | 'disconnecting',
listener: StateChangeListener
): this;
prependListener(event: 'disconnected', listener: DisconnectedListener): this;
prependListener(event: 'error', listener: ErrorListener): this;
prependListener(event: 'data', listener: DataListener): this;
prependOnceListener(
event: 'connecting' | 'connected' | 'disconnecting',
listener: StateChangeListener
): this;
prependOnceListener(event: 'disconnected', listener: DisconnectedListener): this;
prependOnceListener(event: 'error', listener: ErrorListener): this;
prependOnceListener(event: 'data', listener: DataListener): this;
emit(event: string | symbol, ...args: any[]): boolean;
emit(
event: 'connecting' | 'connected' | 'disconnecting',
previousState: ElkConnectionState
): void;
emit(event: 'disconnected', previousState: ElkConnectionState, error?: Error): void;
emit(event: 'error', error: Error): void;
emit(event: 'data', data: string): void;
readonly state: ElkConnectionState;
connect(): Promise<ElkConnection>;
disconnect(): Promise<ElkConnection>;
write(data: string): Promise<unknown>;
}