SubscribeHandlers
View as MarkdownDefined in: client/src/client.ts:23
Properties
Section titled “Properties”| Property | Type | Defined in |
|---|---|---|
after |
number |
client/src/client.ts:24 |
Methods
Section titled “Methods”onError()?
Section titled “onError()?”onError?(e): void;Defined in: client/src/client.ts:36
Called in two cases:
- Terminal: the stream stopped for good (state
'offline', no more retries) on a definitive 4xx answer (not_found,unauthorized, …) orevent_replay_unavailable. Subscribe again (after a fresh snapshot) to resume. - Non-terminal:
headers()threw (unauthorized,details.reason: 'headers', e.g. a failed token refresh). Reported once per failure streak while the stream keeps retrying; the nextonState('live')means it recovered. A UI can ask the user to sign in again meanwhile.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
e |
UncageClientError |
Returns
Section titled “Returns”void
onEvent()
Section titled “onEvent()”onEvent(e): void;Defined in: client/src/client.ts:25
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
e |
UncageEvent |
Returns
Section titled “Returns”void
onState()?
Section titled “onState()?”onState?(s): void;Defined in: client/src/client.ts:26
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
s |
ConnectionState |
Returns
Section titled “Returns”void