tauri-store

Appearance

Persisting state ​

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

typescript
import { save, saveAll } from '@tauri-store/vue';

// 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_plugin_vue::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.vue().save("my-store");

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

// Save all stores.
manager.vue().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.

typescript
import { store } from '@tauri-store/vue';

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.

typescript
import { setAutosave, clearAutosave } from '@tauri-store/vue';

// Save every five minutes.
await setAutosave(300);

// Disable the autosave.
await clearAutosave();
rust
use std::time::Duration;

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

Custom directory ​

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

rust
tauri_plugin_vue::Builder::new()
  .path("/path/to/custom/directory")
  .build();

TIP

On Android and iOS, however, the stores are saved in a sandboxed directory. See #221.

To change the path for a specific store only:

rust
tauri_plugin_vue::Builder::new()
  .path_of("my-store", "/path/to/other/directory")
  .build();

Denylist ​

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

typescript
import { denySave, allowSave } from '@tauri-store/vue';

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

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

Cleaning up ​

If you want to dispose of a store and delete it from disk, you can use the destroy method.

typescript
await store.destroy();