Skip to content

@statesync/tauri


@statesync/tauri / CreateTauriRevisionSyncOptions

Interface: CreateTauriRevisionSyncOptions<T>

Defined in: sync.ts:11

Type Parameters

Type Parameter
T

Properties

applier

ts
applier: SnapshotApplier<T>;

Defined in: sync.ts:32


args?

ts
optional args: Record<string, unknown>;

Defined in: sync.ts:30

Optional invoke args passed to the snapshot command.


commandName

ts
commandName: string;

Defined in: sync.ts:25

Tauri command name used to fetch a snapshot.


eventName

ts
eventName: string;

Defined in: sync.ts:20

Event name used for invalidation events.


invoke

ts
invoke: TauriInvoke;

Defined in: sync.ts:15


listen

ts
listen: TauriListen;

Defined in: sync.ts:14


logger?

ts
optional logger: Logger;

Defined in: sync.ts:38


onError()?

ts
optional onError: (ctx) => void;

Defined in: sync.ts:39

Parameters

ParameterType
ctxSyncErrorContext

Returns

void


shouldRefresh()?

ts
optional shouldRefresh: (event) => boolean;

Defined in: sync.ts:37

Optional pass-through options to core.

Parameters

ParameterType
eventInvalidationEvent

Returns

boolean


topic

ts
topic: string;

Defined in: sync.ts:12

Released under the MIT License.