Persisting state

All your stores are automatically persisted to disk upon a graceful exit, but you can also manually save them if needed:

JavaScript

import { save, saveAll } from 'tauri-store';

// Save a single store.
await save('my-store');

// Save some stores.
await save('store-1', 'store-2', 'store-3');

// Save all stores.
await saveAll();

Rust

use tauri_store::ManagerExt;

// Here, "manager" represents any type that implements the "Manager" trait provided by Tauri.
// This includes "AppHandle", "Window", and "WebviewWindow".
// See: https://docs.rs/tauri/latest/tauri/trait.Manager.html

// Save a single store.
manager.store_collection().save("my-store");

// Save some stores.
manager.store_collection().save_some(&["store-1", "store-2"]);

// Save all stores.
manager.store_collection().save_all();

Save on change

If there's a need to save a store whenever its state changes, you can enable the saveOnChange option when defining the store.

import { store } from 'tauri-store';

const value = { counter: 0 };
const counterStore = store('counter', value, {
  saveOnChange: true,

  // You can also debounce or throttle when saving.
  // This is optional. The default behavior is to save immediately.
  saveStrategy: 'debounce',
  saveInterval: 1000,
});

Autosave

You can also enable autosave to periodically write the stores to disk.

src-tauri/src/lib.rs

use std::time::Duration;

// Save every five minutes.
tauri_store::Builder::new()
  .autosave(Duration::from_secs(300))
  .build_plugin();

Custom directory

By default, the stores are saved in a directory called tauri-store within your app's data directory. You can change this by setting the path option during the plugin's initialization.

src-tauri/src/lib.rs

tauri_store::Builder::new()
  .path("/path/to/custom/directory")
  .build_plugin();

The path can also be modified at runtime. In this case, all currently active stores will be moved to the new directory.

JavaScript

import { setStoreCollectionPath } from 'tauri-store';

await setStoreCollectionPath('/path/to/new/directory');

Rust

use tauri_store::ManagerExt;

manager.store_collection().set_path("/path/to/new/directory");

Denylist

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

src-tauri/src/lib.rs

tauri_store::Builder::new()
  .save_denylist(&["store-1", "store-2"])
  .build_plugin();