CircuitsGroupSyncResult
Defined in: packages/client/src/circuits/group-sync.ts:192
Properties
Section titled “Properties”ensureGroupStarted
Section titled “ensureGroupStarted”ensureGroupStarted: (
groupKey) =>Promise<void>
Defined in: packages/client/src/circuits/group-sync.ts:200
Start a held lazy group. Idempotent and single-flight; resolves once it has caught up — EXCEPT for an already-promoted group, which resolves at once because it is durable and boot-started (ADR-0021 §2), so its catch-up must not gate a read.
Parameters
Section titled “Parameters”groupKey
Section titled “groupKey”string
Returns
Section titled “Returns”Promise<void>
groupKeyForTable
Section titled “groupKeyForTable”groupKeyForTable: (
tableKey) =>string|undefined
Defined in: packages/client/src/circuits/group-sync.ts:207
Parameters
Section titled “Parameters”tableKey
Section titled “tableKey”string
Returns
Section titled “Returns”string | undefined
groupKeys
Section titled “groupKeys”groupKeys: () =>
string[]
Defined in: packages/client/src/circuits/group-sync.ts:216
Returns
Section titled “Returns”string[]
groupReady
Section titled “groupReady”groupReady: (
groupKey) =>Promise<void>
Defined in: packages/client/src/circuits/group-sync.ts:214
Parameters
Section titled “Parameters”groupKey
Section titled “groupKey”string
Returns
Section titled “Returns”Promise<void>
isGroupReady
Section titled “isGroupReady”isGroupReady: (
groupKey) =>boolean
Defined in: packages/client/src/circuits/group-sync.ts:215
Parameters
Section titled “Parameters”groupKey
Section titled “groupKey”string
Returns
Section titled “Returns”boolean
isTableStarted
Section titled “isTableStarted”isTableStarted: (
tableKey) =>boolean
Defined in: packages/client/src/circuits/group-sync.ts:213
Whether the table’s group is STARTED — a durable subscription for it exists, so reads of it are meaningful. NOT the same question as caught up, which is CircuitsGroupSyncResult.isGroupReady: a promoted group is started from boot even while its first subscribe is still retrying.
Parameters
Section titled “Parameters”tableKey
Section titled “tableKey”string
Returns
Section titled “Returns”boolean
stopGroup
Section titled “stopGroup”stopGroup: (
groupKey) =>void
Defined in: packages/client/src/circuits/group-sync.ts:206
Tear a group’s streams down and return it to dormant, so a later start re-subscribes. Also drops the group’s promotion for this session — a desync truncates the local copy, so the group is held again and re-activates (and re-persists its flag) on its next reference.
Parameters
Section titled “Parameters”groupKey
Section titled “groupKey”string
Returns
Section titled “Returns”void
tables
Section titled “tables”tables:
Record<string,CircuitsTableSyncResult>
Defined in: packages/client/src/circuits/group-sync.ts:194
unsubscribe
Section titled “unsubscribe”unsubscribe: () =>
void
Defined in: packages/client/src/circuits/group-sync.ts:193
Returns
Section titled “Returns”void