Skip to main content

Interface: SyncPolicy

Defined in: contract.ts:85

@rasd/sync — the public entry point.

Two things ship here: the engine (createSyncEngine), which is transport agnostic and drives @rasd/storage's outbox, and the RSP v1 transport (createRspTransport), which is one implementation of the frozen SyncTransport port. A host talking to ODK Central, KoboToolbox or its own backend replaces the second without touching the first (docs/10-sync-protocol.md §10).

Nothing in this file has an implementation; every symbol is re-exported from the module that owns it, so the graph stays a DAG: contract → types → policy / backoff / classify → idempotency → rsp-transport → engine.

Properties​

attachmentParallel​

attachmentParallel: number;

Defined in: contract.ts:93

Concurrent attachment uploads.


backoffMaxMs​

backoffMaxMs: number;

Defined in: contract.ts:90


backoffMinMs​

backoffMinMs: number;

Defined in: contract.ts:89

Retry backoff, milliseconds. Full jitter is applied on top.


batchSize​

batchSize: number;

Defined in: contract.ts:87

Max submissions per batch (docs/10 §3.2 caps this at 50).


maxAttempts​

maxAttempts: number;

Defined in: contract.ts:91


pauseOnMetered​

pauseOnMetered: boolean;

Defined in: contract.ts:95

Skip attachment upload while the connection is metered.


pollMs​

pollMs: number;

Defined in: contract.ts:99

Poll interval when the host asks for periodic sync; 0 disables.


purgeSyncedAfterDays​

purgeSyncedAfterDays: number;

Defined in: contract.ts:97

Delete synced local bytes after this many days; 0 = immediately.