@statesync/pinia

Pinia adapter for state-sync. Applies snapshots to a Pinia store.

Install

npm install @statesync/pinia @statesync/core

Quick Start

import { createRevisionSync } from '@statesync/core';
import { createPiniaSnapshotApplier } from '@statesync/pinia';

const store = useMyStore();

const applier = createPiniaSnapshotApplier(store);

const handle = createRevisionSync({
  topic: 'settings',
  subscriber: mySubscriber,
  provider: myProvider,
  applier,
});

await handle.start();

Modes

Patch (default)

const applier = createPiniaSnapshotApplier(store);
// Calls store.$patch(data) — merges fields

Replace

const applier = createPiniaSnapshotApplier(store, { mode: 'replace' });
// Full replacement: deletes missing keys, assigns new ones

Options

• toState(data, ctx) — map snapshot data → state patch
• pickKeys / omitKeys — limit which keys are updated
• strict (default: true) — throw if toState returns a non-object

See full documentation.