@tauri-apps/plugin-store

Classes

LazyStore

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L89

A lazy loaded key-value store persisted by the backend layer.

Implements

• IStore

Constructors

Constructor

new LazyStore(path, options?): LazyStore;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L104

Note that the options are not applied if someone else already created the store

Parameters

Parameter	Type	Description
path	string	Path to save the store in app_data_dir
options?	StoreOptions	Store configuration options

Returns

LazyStore

Methods

clear()

clear(): Promise<void>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L132

Clears the store, removing all key-value pairs.

Note: To clear the storage and reset it to its default value, use reset instead.

Returns

Promise<void>

Implementation of

IStore.clear

close()

close(): Promise<void>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L177

Close the store and cleans up this resource from memory. You should not call any method on this object anymore and should drop any reference to it.

Returns

Promise<void>

Implementation of

IStore.close

delete()

delete(key): Promise<boolean>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L128

Removes a key-value pair from the store.

Parameters

Parameter	Type	Description
key	string	-

Returns

Promise<boolean>

Implementation of

IStore.delete

entries()

entries<T>(): Promise<[string, T][]>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L148

Returns a list of all entries in the store.

Type Parameters

Type Parameter
T

Returns

Promise<[string, T][]>

Implementation of

IStore.entries

get()

get<T>(key): Promise<T | undefined>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L120

Returns the value for the given key or undefined if the key does not exist.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
key	string	-

Returns

Promise<T | undefined>

Implementation of

IStore.get

has()

has(key): Promise<boolean>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L124

Returns true if the given key exists in the store.

Parameters

Parameter	Type	Description
key	string	-

Returns

Promise<boolean>

Implementation of

IStore.has

init()

init(): Promise<void>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L112

Init/load the store if it’s not loaded already

Returns

Promise<void>

keys()

keys(): Promise<string[]>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L140

Returns a list of all keys in the store.

Returns

Promise<string[]>

Implementation of

IStore.keys

length()

length(): Promise<number>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L152

Returns the number of key-value pairs in the store.

Returns

Promise<number>

Implementation of

IStore.length

onChange()

onChange<T>(cb): Promise<UnlistenFn>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L171

Listen to changes on the store.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
cb	(key, value) => void	-

Returns

Promise<UnlistenFn>

A promise resolving to a function to unlisten to the event.

Since

2.0.0

Implementation of

IStore.onChange

onKeyChange()

onKeyChange<T>(key, cb): Promise<UnlistenFn>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L164

Listen to changes on a store key.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
key	string	-
cb	(value) => void	-

Returns

Promise<UnlistenFn>

A promise resolving to a function to unlisten to the event.

Since

2.0.0

Implementation of

IStore.onKeyChange

reload()

reload(options?): Promise<void>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L156

Attempts to load the on-disk state at the store’s path into memory.

This method is useful if the on-disk state was edited by the user and you want to synchronize the changes.

Note:

• This method loads the data and merges it with the current store, this behavior will be changed to resetting to default first and then merging with the on-disk state in v3, to fully match the store with the on-disk state, set ignoreDefaults to true
• This method does not emit change events.

Parameters

Parameter	Type
options?	ReloadOptions

Returns

Promise<void>

Implementation of

IStore.reload

reset()

reset(): Promise<void>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L136

Resets the store to its default value.

If no default value has been set, this method behaves identical to clear.

Returns

Promise<void>

Implementation of

IStore.reset

save()

save(): Promise<void>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L160

Saves the store to disk at the store’s path.

Returns

Promise<void>

Implementation of

IStore.save

set()

set(key, value): Promise<void>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L116

Inserts a key-value pair into the store.

Parameters

Parameter	Type	Description
key	string	-
value	unknown	-

Returns

Promise<void>

Implementation of

IStore.set

values()

values<T>(): Promise<T[]>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L144

Returns a list of all values in the store.

Type Parameters

Type Parameter
T

Returns

Promise<T[]>

Implementation of

IStore.values

---

Store

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L187

A key-value store persisted by the backend layer.

Extends

• Resource

Implements

• IStore

Accessors

rid

Get Signature

get rid(): number;

Source: undefined

Returns

number

Inherited from

Resource.rid

Methods

clear()

clear(): Promise<void>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L267

Clears the store, removing all key-value pairs.

Note: To clear the storage and reset it to its default value, use reset instead.

Returns

Promise<void>

Implementation of

IStore.clear

close()

close(): Promise<void>;

Source: undefined

Destroys and cleans up this resource from memory. You should not call any method on this object anymore and should drop any reference to it.

Returns

Promise<void>

Implementation of

IStore.close

Inherited from

Resource.close

delete()

delete(key): Promise<boolean>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L260

Removes a key-value pair from the store.

Parameters

Parameter	Type	Description
key	string	-

Returns

Promise<boolean>

Implementation of

IStore.delete

entries()

entries<T>(): Promise<[string, T][]>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L283

Returns a list of all entries in the store.

Type Parameters

Type Parameter
T

Returns

Promise<[string, T][]>

Implementation of

IStore.entries

get()

get<T>(key): Promise<T | undefined>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L245

Returns the value for the given key or undefined if the key does not exist.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
key	string	-

Returns

Promise<T | undefined>

Implementation of

IStore.get

has()

has(key): Promise<boolean>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L253

Returns true if the given key exists in the store.

Parameters

Parameter	Type	Description
key	string	-

Returns

Promise<boolean>

Implementation of

IStore.has

keys()

keys(): Promise<string[]>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L275

Returns a list of all keys in the store.

Returns

Promise<string[]>

Implementation of

IStore.keys

length()

length(): Promise<number>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L287

Returns the number of key-value pairs in the store.

Returns

Promise<number>

Implementation of

IStore.length

onChange()

onChange<T>(cb): Promise<UnlistenFn>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L310

Listen to changes on the store.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
cb	(key, value) => void	-

Returns

Promise<UnlistenFn>

A promise resolving to a function to unlisten to the event.

Since

2.0.0

Implementation of

IStore.onChange

onKeyChange()

onKeyChange<T>(key, cb): Promise<UnlistenFn>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L299

Listen to changes on a store key.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
key	string	-
cb	(value) => void	-

Returns

Promise<UnlistenFn>

A promise resolving to a function to unlisten to the event.

Since

2.0.0

Implementation of

IStore.onKeyChange

reload()

reload(options?): Promise<void>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L291

Attempts to load the on-disk state at the store’s path into memory.

This method is useful if the on-disk state was edited by the user and you want to synchronize the changes.

Note:

• This method loads the data and merges it with the current store, this behavior will be changed to resetting to default first and then merging with the on-disk state in v3, to fully match the store with the on-disk state, set ignoreDefaults to true
• This method does not emit change events.

Parameters

Parameter	Type
options?	ReloadOptions

Returns

Promise<void>

Implementation of

IStore.reload

reset()

reset(): Promise<void>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L271

Resets the store to its default value.

If no default value has been set, this method behaves identical to clear.

Returns

Promise<void>

Implementation of

IStore.reset

save()

save(): Promise<void>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L295

Saves the store to disk at the store’s path.

Returns

Promise<void>

Implementation of

IStore.save

set()

set(key, value): Promise<void>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L237

Inserts a key-value pair into the store.

Parameters

Parameter	Type	Description
key	string	-
value	unknown	-

Returns

Promise<void>

Implementation of

IStore.set

values()

values<T>(): Promise<T[]>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L279

Returns a list of all values in the store.

Type Parameters

Type Parameter
T

Returns

Promise<T[]>

Implementation of

IStore.values

get()

static get(path): Promise<Store | null>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L231

Gets an already loaded store.

If the store is not loaded, returns null. In this case you must load it.

This function is more useful when you already know the store is loaded and just need to access its instance. Prefer Store.load otherwise.

Parameters

Parameter	Type	Description
path	string	Path of the store.

Returns

Promise<Store | null>

Example

import { Store } from '@tauri-apps/api/store';
let store = await Store.get('store.json');
if (!store) {
  store = await Store.load('store.json');
}

load()

static load(path, options?): Promise<Store>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L204

Create a new Store or load the existing store with the path.

Parameters

Parameter	Type	Description
path	string	Path to save the store in app_data_dir
options?	StoreOptions	Store configuration options

Returns

Promise<Store>

Example

import { Store } from '@tauri-apps/api/store';
const store = await Store.load('store.json');

Type Aliases

ReloadOptions

type ReloadOptions = object;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L457

Options to IStore.reload a IStore

Properties

Property	Type	Description	Defined in
ignoreDefaults?	boolean	To fully match the store with the on-disk state, ignoring defaults	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L461

---

StoreOptions

type StoreOptions = object;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L20

Options to create a store

Properties

Property	Type	Description	Defined in
autoSave?	boolean | number	Auto save on modification with debounce duration in milliseconds, it’s 100ms by default, pass in false to disable it	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L28
createNew?	boolean	Force create a new store with default values even if it already exists.	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L40
defaults?	object	Default value of the store	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L24
deserializeFnName?	string	Name of a deserialize function registered in the rust side plugin builder	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L36
overrideDefaults?	boolean	When creating the store, override the store with the on-disk state if it exists, ignoring defaults	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L44
serializeFnName?	string	Name of a serialize function registered in the rust side plugin builder	Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L32

Functions

getStore()

function getStore(path): Promise<Store | null>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L82

Gets an already loaded store.

If the store is not loaded, returns null. In this case you must load it.

This function is more useful when you already know the store is loaded and just need to access its instance. Prefer Store.load otherwise.

Parameters

Parameter	Type	Description
path	string	Path of the store.

Returns

Promise<Store | null>

Example

import { getStore } from '@tauri-apps/api/store';
const store = await getStore('store.json');

---

load()

function load(path, options?): Promise<Store>;

Source: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L59

Create a new Store or load the existing store with the path.

Parameters

Parameter	Type	Description
path	string	Path to save the store in app_data_dir
options?	StoreOptions	Store configuration options

Returns

Promise<Store>

Example

import { Store } from '@tauri-apps/api/store';
const store = await Store.load('store.json');