tauri-store

Appearance

Synchronization ​

Whenever the state changes, the store notifies Rust to keep the frontend and backend in sync. However, since data is serialized with each notification, frequent updates can be resource-intensive. One way to address this issue is by applying debouncing or throttling, making the synchronization process more efficient.

typescript
import { create } from 'zustand';
import { createTauriStore } from '@tauri-store/zustand';

const useCounterStore = create<{ counter: number }>((set) => ({
  counter: 0,
}));

const tauriHandler = createTauriStore('counter', useCounterStore, {
  syncStrategy: 'debounce',
  syncInterval: 1000,
});

Debounce or throttle?

For a detailed explanation of the differences between debouncing and throttling, take a look at this article.

While this process isn’t directly related to store persistence, it can still affect what gets saved. When a store is saved, the data written to disk comes from Rust’s cache at that moment. If the synchronization hasn’t finished yet, Rust might still be working with outdated values.

Filtering keys ​

For finer control over which keys are synced with the backend, you can set a filter strategy when defining the store.

typescript
import { create } from 'zustand';
import { createTauriStore } from '@tauri-store/zustand';

type CounterStore = { counter: number, ignoreMe: string };

const useCounterStore = create<CounterStore>((set) => ({
  counter: 0,
  ignoreMe: 'hello darkness, my old friend',
}));

const tauriHandler = createTauriStore('counter', useCounterStore, {
  filterKeys: ['ignoreMe'],
  filterKeysStrategy: 'omit',
});

TIP

filterKeysStrategy can also accept a callback to dynamically check if the key should be filtered.

Denylist ​

If a store should be saved to disk, but not synchronized across windows, you can add it to the denylist.

typescript
import { denySync, allowSync } from '@tauri-store/zustand';

await denySync('store-1', 'store-2');

// To allow them again:
await allowSync('store-1', 'store-2');
rust
tauri_plugin_zustand::Builder::new()
  .sync_denylist(&["store-1", "store-2"])
  .build();