@armada/sdk / index / AutoSyncOptions

Interface: AutoSyncOptions

Defined in: src/sync/auto-sync.ts:8

Options for startAutoSync. The timer functions are injectable so the loop is deterministically testable; they default to the global setTimeout/clearTimeout.

Properties

intervalMs

readonly intervalMs: number

Defined in: src/sync/auto-sync.ts:10

Steady-state cadence between sync runs, in ms.

---

immediate?

readonly optional immediate?: boolean

Defined in: src/sync/auto-sync.ts:12

Run once immediately on start (default true); set false to wait one intervalMs before the first run.

---

maxBackoffMs?

readonly optional maxBackoffMs?: number

Defined in: src/sync/auto-sync.ts:14

Ceiling on the exponential error backoff, in ms (default 30000 — matches the stock engine's poller).

---

onError?

readonly optional onError?: (err) => void

Defined in: src/sync/auto-sync.ts:16

Called with any error a sync run throws; the loop keeps running (backed off) regardless.

Parameters

err

Error

Returns

void

---

setTimer?

readonly optional setTimer?: (fn, ms) => unknown

Defined in: src/sync/auto-sync.ts:18

Schedule fn after ms; returns a handle passed back to clearTimer. Defaults to setTimeout.

Parameters

fn

() => void

ms

number

Returns

unknown

---

clearTimer?

readonly optional clearTimer?: (handle) => void

Defined in: src/sync/auto-sync.ts:20

Cancel a handle from setTimer. Defaults to clearTimeout.

Parameters

handle

unknown

Returns

void