/
types.ts
187 lines (172 loc) · 4.1 KB
/
types.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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
import { Broadcaster } from "./Broadcaster";
import { BroadcasterBridge } from "./bridges/Bridge";
/**
* Basic info about remote broadcaster instance
*
* @public
*/
export type BroadcasterState<Metadata> = {
/**
* Indicates time when a broadcaster was created
*/
createdAt: number;
/**
* Broadcaster ID
*/
id: string;
/**
* Broadcaster instance metadata
*/
metadata: Metadata;
};
/**
* Basic info about remote broadcaster instance
*
* @public
*/
export type BroadcasterInstanceDescriptor<Metadata> = BroadcasterState<Metadata> & {
inactive?: boolean;
lastUpdate: number;
};
/**
* An object representing public message from other broadcaster instance.
*
* @public
*/
export type BroadcasterMessage<Payload> = {
from: string;
payload: Payload;
to?: string | string[];
};
/**
* State update message received from another Broadcaster instance.
*
* @private
*/
export type BroadcasterStateMessage<Metadata> = {
/**
* ID of an message owner.
*/
from: string;
/**
* Owners state object.
*/
state?: BroadcasterState<Metadata>;
/**
* Broadcaster ID, which will be used as a message address.
*/
to?: string;
/**
* Message type.
*/
type: StateMessageType;
};
/**
* Broadcasting class settings
*
* @public
*/
export type BroadcasterSettings<Payload, Metadata> = {
/**
* Replaces default BroadcasterBridge. Allows to use communication layer other then
* BroadcasterChannel API (for example WebSocket layer).
*
* @default BroadcastChannelBridge
*/
bridge?: BroadcasterBridge<BroadcasterMessage<Payload>, BroadcasterStateMessage<Metadata>>;
/**
* Unique channel name, which will be used as a communication key
*/
channel: string;
/**
* Broadcaster regularly sends health status messages.
* When some instance does not response for specified time,
* it will be considered as a dead instance and will be removed
* from broadcasters list.
*
* This option allows to disable this feature
*/
disableGarbageCollector?: boolean;
/**
* Broadcaster regularly sends health status messages.
* When some instance does not response for specified time,
* it will be considered as a dead instance and will be removed
* from broadcasters list.
*
* This props sets a time after which broadcaster reference will be
* considered terminated and garbage collected.
*
* @units ms
* @default 1500
*/
garbageCollectorThresholdTimer?: number;
/**
* Interval in which Broadcasters health status will be checked
* and all of those which cross removal threshold will be deleted.
*
* @units ms
* @default 500
*/
garbageCollectorTimer?: number;
/**
* Interval in which Broadcaster will periodically
* sends health status message
*
* @units ms
* @default 500
*/
healthBeaconTimer?: number;
/**
* Initial metadata
*/
metadata: Metadata;
/**
* Middleware allowing to transform a message
*/
middlewares?: {
/**
* Allows to modify incoming message.
*
* @param message
* @returns
*/
after: (message: unknown) => Payload;
/**
* Allows to modify outgoing message.
*
* @param message
* @returns
*/
before: (message: Payload) => unknown;
};
/**
* Lifecycle events
*/
on?: Partial<{
/**
* Called before Broadcaster is destroyed.
*
* @param broadcaster
* @returns
*/
close: (broadcaster: Broadcaster<Payload, Metadata>) => void;
/**
* Called right after broadcaster initialization
*
* @param broadcaster
* @returns
*/
init: (broadcaster: Broadcaster<Payload, Metadata>) => void;
}>;
}
/**
* Allowed state message types
*
* @private
*/
export enum StateMessageType {
CONNECTED,
UPDATED,
DISCONNECTED,
HEALTH_BEACON,
}