@statesync/core / RevisionSyncOptions
Interface: RevisionSyncOptions<T>
Defined in: engine.ts:43
Configuration options for creating a revision-based sync loop.
Provides all the dependencies and behavioral hooks the engine needs to subscribe to invalidation events, fetch snapshots, apply them locally, and handle errors. Pass this to createRevisionSync to obtain a RevisionSyncHandle.
Example
const options: RevisionSyncOptions<UserProfile> = {
topic: 'user-profile',
subscriber: myWebSocketSubscriber,
provider: { getSnapshot: () => fetch('/api/snapshot').then(r => r.json()) },
applier: { apply: ({ data }) => store.setState(data) },
logger: createConsoleLogger({ debug: true }),
onError: (ctx) => Sentry.captureException(ctx.error),
throttling: { debounceMs: 200 },
};Type Parameters
| Type Parameter | Description |
|---|---|
T | The application-specific snapshot data type. |
Properties
applier
applier: SnapshotApplier<T>;Defined in: engine.ts:66
The snapshot applier that writes fetched data into local state. Called only when the fetched snapshot has a higher revision than the current local revision.
logger?
optional logger: Logger;Defined in: engine.ts:79
Optional logger for tracing engine lifecycle events and errors. If omitted, the engine operates silently.
onError()?
optional onError: (ctx) => void;Defined in: engine.ts:86
Optional error callback invoked whenever the engine encounters an error. Receives a SyncErrorContext with structured details about the failure.
Parameters
| Parameter | Type | Description |
|---|---|---|
ctx | SyncErrorContext | The structured error context. |
Returns
void
provider
provider: SnapshotProvider<T>;Defined in: engine.ts:60
The snapshot provider used to fetch the latest authoritative state. Called during the initial load and after each invalidation event that passes the revision and shouldRefresh checks.
shouldRefresh()?
optional shouldRefresh: (event) => boolean;Defined in: engine.ts:74
Optional predicate that can suppress a refresh for a specific invalidation event. Return false to skip the refresh; return true (or omit) to allow it.
Parameters
| Parameter | Type | Description |
|---|---|---|
event | InvalidationEvent | The normalized InvalidationEvent that triggered the refresh. |
Returns
boolean
Whether the engine should proceed with the refresh.
subscriber
subscriber: InvalidationSubscriber;Defined in: engine.ts:54
The invalidation subscriber that delivers real-time change notifications. The engine subscribes to it on RevisionSyncHandle.start and unsubscribes on RevisionSyncHandle.stop.
throttling?
optional throttling: InvalidationThrottlingOptions;Defined in: engine.ts:94
Optional throttling configuration to control refresh rate.
Use debounceMs to wait for "silence" before refreshing. Use throttleMs to limit refresh frequency. Both can be combined: debounce is applied first, within the throttle window.
topic
topic: string;Defined in: engine.ts:48
The topic identifier that scopes this sync loop. Must be a non-empty string; the engine validates this at creation time.