Interface SyncConfig

Sync configuration options.

interface SyncConfig {
    mode?: SyncMode;
    direction?: SyncDirection;
    conflictStrategy?: ConflictStrategy;
    interval?: number;
    debounce?: number;
    batchSize?: number;
    retryOnError?: boolean;
    maxRetries?: number;
    retryDelay?: number;
    tables?: Record<string, TableSyncConfig>;
    mobileStorageLimit?: number;
    storageLimitAction?: StorageLimitAction;
    includeTables?: string[];
    excludeTables?: string[];
}

Properties

mode? direction? conflictStrategy? interval? debounce? batchSize? retryOnError? maxRetries? retryDelay? tables? mobileStorageLimit? storageLimitAction? includeTables? excludeTables?

Properties

Optionalmode

mode?: SyncMode

Sync mode - when synchronization occurs

Optionaldirection

direction?: SyncDirection

Sync direction - which way data flows

OptionalconflictStrategy

conflictStrategy?: ConflictStrategy

Conflict resolution strategy

Optionalinterval

interval?: number

Interval in ms for periodic sync (default: 30000 = 30s)

Optionaldebounce

debounce?: number

Debounce delay in ms for auto sync (default: 500ms)

OptionalbatchSize

batchSize?: number

Batch size - sync N records at a time (default: 100)

OptionalretryOnError

retryOnError?: boolean

Retry failed syncs automatically

OptionalmaxRetries

maxRetries?: number

Max retry attempts (default: 3)

OptionalretryDelay

retryDelay?: number

Retry delay in ms (default: 1000)

Optionaltables

tables?: Record<string, TableSyncConfig>

Per-table sync configuration

OptionalmobileStorageLimit

mobileStorageLimit?: number

Mobile storage limit in MB (default: 50MB)

OptionalstorageLimitAction

storageLimitAction?: StorageLimitAction

Action when storage limit reached

OptionalincludeTables

includeTables?: string[]

Only sync specific tables (undefined = all)

OptionalexcludeTables

excludeTables?: string[]

Exclude specific tables from sync

Settings

Member Visibility

On This Page

Properties