Lelantos SDK

Appearance

@lelantos-org/sdk / wallet / SyncOpts

Interface: SyncOpts ​

Defined in: @lelantos-org/sdk/dist/wallet/sync.d.ts:52

Properties ​

limit? ​

ts
optional limit?: number;

Defined in: @lelantos-org/sdk/dist/wallet/sync.d.ts:54

Page size. Not a ceiling on notes fetched.

onProgress? ​

ts
optional onProgress?: (p) => void;

Defined in: @lelantos-org/sdk/dist/wallet/sync.d.ts:55

Parameters ​

ParameterType
pSyncProgress

Returns ​

void

signal? ​

ts
optional signal?: AbortSignal;

Defined in: @lelantos-org/sdk/dist/wallet/sync.d.ts:64

Stops paging at the next page boundary.

Checkpointing is unaffected: whatever was scanned before the abort is persisted, so the next sync resumes from there rather than re-scanning. Without this a sync could page through MAX_PAGES × limit notes — ten million at the defaults — with no way for the caller to stop it.