Skip to content

SubscribeHandlers

View as Markdown

Defined in: client/src/client.ts:23

Property Type Defined in
after number client/src/client.ts:24
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, …) or event_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 next onState('live') means it recovered. A UI can ask the user to sign in again meanwhile.
Parameter Type
e UncageClientError

void


onEvent(e): void;

Defined in: client/src/client.ts:25

Parameter Type
e UncageEvent

void


onState?(s): void;

Defined in: client/src/client.ts:26

Parameter Type
s ConnectionState

void