@tauri-store/valtio - v3.2.0
    Preparing search index...

    Interface StoreBuilderReturn<S>

    A contract that a store must adhere to in order to be considered a valid implementation.

    interface StoreBuilderReturn<S extends State> {
        destroy: () => Promise<void>;
        getPath: () => Promise<string>;
        id: string;
        save: () => Promise<void>;
        saveAll: () => Promise<void>;
        saveAllNow: () => Promise<void>;
        saveNow: () => Promise<void>;
        start: () => Promise<void>;
        state: S;
        stop: () => Promise<void>;
        subscribe: (
            callback: (unstable_ops: Op[]) => void,
            notifyInSync?: boolean,
        ) => Fn;
        subscribeKey: <Key extends string | number | symbol>(
            key: Key,
            callback: (value: S[Key]) => void,
            notifyInSync?: boolean,
        ) => Fn;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    destroy getPath id save saveAll saveAllNow saveNow start state stop subscribe subscribeKey

    Properties

    destroy: () => Promise<void>

    Destroys the store, cleans up its Rust state, and deletes the file.

    getPath: () => Promise<string>

    Path where the store is saved.

    id: string

    Store id.

    save: () => Promise<void>

    Saves the store to the disk.

    saveAll: () => Promise<void>

    Saves all stores to the disk.

    saveAllNow: () => Promise<void>

    Saves all the stores to the disk immediately, ignoring the save strategy.

    saveNow: () => Promise<void>

    Saves the store to the disk immediately, ignoring the save strategy.

    start: () => Promise<void>

    Starts watching for changes.

    state: S

    Valtio proxy state.

    https://valtio.dev/docs/api/basic/proxy

    stop: () => Promise<void>

    Stops watching for changes.

    subscribe: (
        callback: (unstable_ops: Op[]) => void,
        notifyInSync?: boolean,
    ) => Fn

    Subscribes to changes in the store.

    https://valtio.dev/docs/api/advanced/subscribe

    subscribeKey: <Key extends string | number | symbol>(
        key: Key,
        callback: (value: S[Key]) => void,
        notifyInSync?: boolean,
    ) => Fn

    Subscribes to changes in a key of the store.

    https://valtio.dev/docs/api/utils/subscribeKey

    Settings

    Member Visibility

    On This Page

    Properties