Documentation / @super-line/client / ClientErrorInfo

Interface: ClientErrorInfo

Defined in: index.ts:249

What went wrong, passed to the client onError sink alongside the caught error.

Properties

collection?

optional collection?: string

Defined in: index.ts:263

For resubscribe: the collection whose subscription failed.

---

id?

optional id?: string

Defined in: index.ts:265

For resubscribe: the document id, when it was a CRDT open rather than a row subscription.

---

kind

kind: "connect" | "disconnect" | "reconnect" | "resubscribe" | "tap"

Defined in: index.ts:261

Which lifecycle hook threw — or resubscribe when a settled collection subscription or open document failed to re-establish after a reconnect (e.g. FORBIDDEN because the read policy is re-evaluated on every resubscribe, or TIMEOUT). ready is long resolved by then, so this sink is the only signal.

A resubscribe error means that subscription is no longer live: the failure itself triggers no retry, and nothing else will until the next transport reopen. Treat it as dead — resubscribe, or fail the process.

tap is a plugin's onClientSideEvent throwing. It is isolated here rather than propagated, so an observer can never fail the operation it was observing.