CircuitsSyncOptions

Defined in: packages/client/src/circuits/sync-engine.ts:93

Properties

bootStamp?

optional bootStamp?: GroupBootStamp

Defined in: packages/client/src/circuits/sync-engine.ts:109

Boot observability (ADR-0034). Present only for a BOOT group — an on-demand lazy activation gets none, so post-boot traffic never enters a finalized report.

---

commitRetryDelayMs?

optional commitRetryDelayMs?: (attempt) => number

Defined in: packages/client/src/circuits/sync-engine.ts:129

Parameters

attempt

number

Returns

number

---

debug?

optional debug?: boolean

Defined in: packages/client/src/circuits/sync-engine.ts:130

---

fetch?

optional fetch?: typeof fetch

Defined in: packages/client/src/circuits/sync-engine.ts:131

---

key

key: string | null

Defined in: packages/client/src/circuits/sync-engine.ts:97

Subscription key for persisted resume state; null disables persistence.

---

live?

optional live?: boolean

Defined in: packages/client/src/circuits/sync-engine.ts:127

Long-poll the tail after catching up (default). false reads each stream to its tail and stops — a one-shot hydration rather than a live subscription.

---

maxCommitRetries?

optional maxCommitRetries?: number

Defined in: packages/client/src/circuits/sync-engine.ts:128

---

metadataSchema

metadataSchema: string

Defined in: packages/client/src/circuits/sync-engine.ts:98

---

onInitialSync?

optional onInitialSync?: () => void

Defined in: packages/client/src/circuits/sync-engine.ts:110

Returns

void

---

onStreamEnd?

optional onStreamEnd?: (shapeName, error) => void

Defined in: packages/client/src/circuits/sync-engine.ts:122

One shape’s read ended — null for a normal end, an error for a stream that died mid-session.

Passed through from the shape group and deliberately NOT acted on here. Recovery is a re-subscribe, and this engine has no subscription: it is handed URLs and a token by the layer above (ADR-0055 decision 10), which is the only layer that can ask the control plane for a fresh grant. Ignored once unsubscribe() has been called — a teardown’s own stream closes are not conditions.

Parameters

shapeName

string

error

Error | null

Returns

void

---

onSyncActivity?

optional onSyncActivity?: () => void

Defined in: packages/client/src/circuits/sync-engine.ts:112

Returns

void

---

onSyncError?

optional onSyncError?: (error) => void

Defined in: packages/client/src/circuits/sync-engine.ts:111

Parameters

error

Error

Returns

void

---

onTokenRejected?

optional onTokenRejected?: (status) => string | Promise<string | null> | null

Defined in: packages/client/src/circuits/sync-engine.ts:101

Parameters

status

number

Returns

string | Promise<string | null> | null

---

pg

pg: Pgwasm

Defined in: packages/client/src/circuits/sync-engine.ts:94

---

readBarrier

readBarrier: () => Promise<ConvergenceBarrier>

Defined in: packages/client/src/circuits/sync-engine.ts:103

Reads the engine barrier through the control plane. Consulted once per alignment generation.

Returns

Promise<ConvergenceBarrier>

---

registry

registry: SyncTableRegistry

Defined in: packages/client/src/circuits/sync-engine.ts:95

---

sessionScoped?

optional sessionScoped?: boolean

Defined in: packages/client/src/circuits/sync-engine.ts:104

---

shapes

shapes: Record<string, CircuitsShapeSpec>

Defined in: packages/client/src/circuits/sync-engine.ts:99

---

token

token: () => string | Promise<string>

Defined in: packages/client/src/circuits/sync-engine.ts:100

Returns

string | Promise<string>