Interface TauriPluginPiniaStoreOptions

interface TauriPluginPiniaStoreOptions {
    debounce?: number;
    deep?: boolean;
    filterKeys?: StoreKeyFilter;
    filterKeysStrategy?: StoreKeyFilterStrategy;
    ignoreKeys?: string | string[];
    onError?: ((error: unknown) => MaybePromise<void>);
}

Hierarchy (view full)

Properties

debounce? deep? filterKeys? filterKeysStrategy? ignoreKeys? onError?

Properties

Optional Readonlydebounce

debounce?: number

Default

0

Optional Readonlydeep

deep?: boolean

Whether the store should be deeply watched for changes.

Deprecated

Default

true

Optional ReadonlyfilterKeys

filterKeys?: StoreKeyFilter

Keys the plugin should save or ignore.

The behavior depends on the value of TauriPluginPiniaStoreOptions.filterKeysStrategy.

Optional ReadonlyfilterKeysStrategy

filterKeysStrategy?: StoreKeyFilterStrategy

Strategy to use when filtering keys.

  • pick: Only the specified keys will be synced and saved.
  • omit: All keys will be synced and saved except the ones specified.

You can also provide a custom function that will be called for each key. If the function returns true, the key will be saved and synced.

Default

'omit'

Optional ReadonlyignoreKeys

ignoreKeys?: string | string[]

Keys the plugin should ignore. Those won't be saved nor synced.

Deprecated

Use TauriPluginPiniaStoreOptions.filterKeys instead.

Optional ReadonlyonError

onError?: ((error: unknown) => MaybePromise<void>)

Custom error handler.

Default

console.error

Settings

Member Visibility

On This Page

Properties