@tauri-apps/plugin-store

Classes

LazyStore

Defined in: plugins/store/guest-js/index.ts:89

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

Implements

• IStore

Constructors

new LazyStore()

new LazyStore(path, options?): LazyStore;

Defined in: plugins/store/guest-js/index.ts:104

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>;

Defined in: plugins/store/guest-js/index.ts:132

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>;

Defined in: plugins/store/guest-js/index.ts:177

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>;

Defined in: plugins/store/guest-js/index.ts:128

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][]>;

Defined in: plugins/store/guest-js/index.ts:148

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>;

Defined in: plugins/store/guest-js/index.ts:120

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>;

Defined in: plugins/store/guest-js/index.ts:124

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>;

Defined in: plugins/store/guest-js/index.ts:112

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

Returns

Promise<void>

keys()

keys(): Promise<string[]>;

Defined in: plugins/store/guest-js/index.ts:140

Returns a list of all keys in the store.

Returns

Promise<string[]>

Implementation of

IStore.keys

length()

length(): Promise<number>;

Defined in: plugins/store/guest-js/index.ts:152

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

Returns

Promise<number>

Implementation of

IStore.length

onChange()

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

Defined in: plugins/store/guest-js/index.ts:171

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>;

Defined in: plugins/store/guest-js/index.ts:164

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>;

Defined in: plugins/store/guest-js/index.ts:156

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>;

Defined in: plugins/store/guest-js/index.ts:136

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>;

Defined in: plugins/store/guest-js/index.ts:160

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

Returns

Promise<void>

Implementation of

IStore.save

set()

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

Defined in: plugins/store/guest-js/index.ts:116

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[]>;

Defined in: plugins/store/guest-js/index.ts:144

Returns a list of all values in the store.

Type Parameters

Type Parameter
T

Returns

Promise<T[]>

Implementation of

IStore.values

---

Store

Defined in: plugins/store/guest-js/index.ts:187

A key-value store persisted by the backend layer.

Extends

• Resource

Implements

• IStore

Accessors

rid

Get Signature

get rid(): number;

Defined in: @tauri-apps/api/core.d.ts:183

Returns

number

Inherited from

Resource.rid

Methods

clear()

clear(): Promise<void>;

Defined in: plugins/store/guest-js/index.ts:267

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>;

Defined in: @tauri-apps/api/core.d.ts:189

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>;

Defined in: plugins/store/guest-js/index.ts:260

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][]>;

Defined in: plugins/store/guest-js/index.ts:283

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>;

Defined in: plugins/store/guest-js/index.ts:245

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>;

Defined in: plugins/store/guest-js/index.ts:253

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[]>;

Defined in: plugins/store/guest-js/index.ts:275

Returns a list of all keys in the store.

Returns

Promise<string[]>

Implementation of

IStore.keys

length()

length(): Promise<number>;

Defined in: plugins/store/guest-js/index.ts:287

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

Returns

Promise<number>

Implementation of

IStore.length

onChange()

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

Defined in: plugins/store/guest-js/index.ts:310

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>;

Defined in: plugins/store/guest-js/index.ts:299

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>;

Defined in: plugins/store/guest-js/index.ts:291

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>;

Defined in: plugins/store/guest-js/index.ts:271

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>;

Defined in: plugins/store/guest-js/index.ts:295

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

Returns

Promise<void>

Implementation of

IStore.save

set()

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

Defined in: plugins/store/guest-js/index.ts:237

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[]>;

Defined in: plugins/store/guest-js/index.ts:279

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>;

Defined in: plugins/store/guest-js/index.ts:231

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>;

Defined in: plugins/store/guest-js/index.ts:204

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;

Defined in: plugins/store/guest-js/index.ts:457

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	plugins/store/guest-js/index.ts:461

---

StoreOptions

type StoreOptions = object;

Defined in: plugins/store/guest-js/index.ts:20

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	plugins/store/guest-js/index.ts:28
createNew?	boolean	Force create a new store with default values even if it already exists.	plugins/store/guest-js/index.ts:40
defaults?	object	Default value of the store	plugins/store/guest-js/index.ts:24
deserializeFnName?	string	Name of a deserialize function registered in the rust side plugin builder	plugins/store/guest-js/index.ts:36
overrideDefaults?	boolean	When creating the store, override the store with the on-disk state if it exists, ignoring defaults	plugins/store/guest-js/index.ts:44
serializeFnName?	string	Name of a serialize function registered in the rust side plugin builder	plugins/store/guest-js/index.ts:32

Functions

getStore()

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

Defined in: plugins/store/guest-js/index.ts:82

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>;

Defined in: plugins/store/guest-js/index.ts:59

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');