Lifecycle hooks

JavaScript

JavaScript hooks can be registered using the StoreHooks option.

import { store } from 'tauri-store';

const value = { counter: 0 };
const counterStore = store('counter', value, {
  hooks: {
    error: (err) => console.error(err),
    beforeBackendSync: (state) => {
      console.log(state);
      return state;
    },
  },
});

beforeBackendSync

Registers a hook to be called before a store sends its state to Rust. This can be used to modify the state before it is sent to the backend.

const hooks: StoreHooks = {
  beforeBackendSync: (state) => {
    state.foo = null;
    state.nested.bar.baz = 'qux';
    return state;
  },
};

beforeFrontendSync

Registers a hook to be called before a store attempts to update itself with data from Rust. This can be used to modify the state before the changes are applied.

const hooks: StoreHooks = {
  beforeFrontendSync: (state) => {
    state.foo = new Set(state.foo);
    state.bar = state.bar.map((value) => value * 2);
    return state;
  },
};

error

Registers a hook to be called when an error is thrown by a store.

const hooks: StoreHooks = {
  error: (err) => console.error(err),
};

Rust

on_load

Registers a hook to be called when a store is loaded.

tauri_store::Builder::new()
  .on_load(|store| {
    println!("store loaded: {}", store.id());
    Ok(())
  })
  .build_plugin()