@tauri-apps/plugin-store

Classes

LazyStore

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

Implements

• IStore

Constructors

new LazyStore()

new LazyStore(path, options?): LazyStore

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

Source: undefined

Methods

clear()

clear(): Promise<void>

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

Source: undefined

close()

close(): Promise<void>

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

Source: undefined

delete()

delete(key): Promise<boolean>

Removes a key-value pair from the store.

Parameters

Parameter	Type	Description
key	string

Returns

Promise<boolean>

Implementation of

IStore.delete

Source: undefined

entries()

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

Returns a list of all entries in the store.

Type Parameters

Type Parameter
T

Returns

Promise<[string, T][]>

Implementation of

IStore.entries

Source: undefined

get()

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

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<undefined | T>

Implementation of

IStore.get

Source: undefined

has()

has(key): Promise<boolean>

Returns true if the given key exists in the store.

Parameters

Parameter	Type	Description
key	string

Returns

Promise<boolean>

Implementation of

IStore.has

Source: undefined

init()

init(): Promise<void>

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

Returns

Promise<void>

Source: undefined

keys()

keys(): Promise<string[]>

Returns a list of all keys in the store.

Returns

Promise<string[]>

Implementation of

IStore.keys

Source: undefined

length()

length(): Promise<number>

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

Returns

Promise<number>

Implementation of

IStore.length

Source: undefined

onChange()

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

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

Source: undefined

onKeyChange()

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

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

Source: undefined

reload()

reload(options?): Promise<void>

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

Source: undefined

reset()

reset(): Promise<void>

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

Source: undefined

save()

save(): Promise<void>

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

Returns

Promise<void>

Implementation of

IStore.save

Source: undefined

set()

set(key, value): Promise<void>

Inserts a key-value pair into the store.

Parameters

Parameter	Type	Description
key	string
value	unknown

Returns

Promise<void>

Implementation of

IStore.set

Source: undefined

values()

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

Returns a list of all values in the store.

Type Parameters

Type Parameter
T

Returns

Promise<T[]>

Implementation of

IStore.values

Source: undefined

---

Store

A key-value store persisted by the backend layer.

Extends

• Resource

Implements

• IStore

Accessors

rid

get rid(): number

Returns

number

Inherited from

Resource.rid

Source: undefined

Methods

clear()

clear(): Promise<void>

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

Source: undefined

close()

close(): Promise<void>

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

Source: undefined

delete()

delete(key): Promise<boolean>

Removes a key-value pair from the store.

Parameters

Parameter	Type	Description
key	string

Returns

Promise<boolean>

Implementation of

IStore.delete

Source: undefined

entries()

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

Returns a list of all entries in the store.

Type Parameters

Type Parameter
T

Returns

Promise<[string, T][]>

Implementation of

IStore.entries

Source: undefined

get()

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

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<undefined | T>

Implementation of

IStore.get

Source: undefined

has()

has(key): Promise<boolean>

Returns true if the given key exists in the store.

Parameters

Parameter	Type	Description
key	string

Returns

Promise<boolean>

Implementation of

IStore.has

Source: undefined

keys()

keys(): Promise<string[]>

Returns a list of all keys in the store.

Returns

Promise<string[]>

Implementation of

IStore.keys

Source: undefined

length()

length(): Promise<number>

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

Returns

Promise<number>

Implementation of

IStore.length

Source: undefined

onChange()

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

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

Source: undefined

onKeyChange()

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

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

Source: undefined

reload()

reload(options?): Promise<void>

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

Source: undefined

reset()

reset(): Promise<void>

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

Source: undefined

save()

save(): Promise<void>

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

Returns

Promise<void>

Implementation of

IStore.save

Source: undefined

set()

set(key, value): Promise<void>

Inserts a key-value pair into the store.

Parameters

Parameter	Type	Description
key	string
value	unknown

Returns

Promise<void>

Implementation of

IStore.set

Source: undefined

values()

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

Returns a list of all values in the store.

Type Parameters

Type Parameter
T

Returns

Promise<T[]>

Implementation of

IStore.values

Source: undefined

get()

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

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<null | Store>

Example

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

Source: undefined

load()

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

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

Source: undefined

Type Aliases

ReloadOptions

type ReloadOptions: object;

Options to IStore.reload a IStore

Type declaration

Name	Type	Description	Defined in
ignoreDefaults	boolean	To fully match the store with the on-disk state, ignoring defaults	Source: undefined

Source: undefined

---

StoreOptions

type StoreOptions: object;

Options to create a store

Type declaration

Name	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: undefined
createNew	boolean	Force create a new store with default values even if it already exists.	Source: undefined
defaults	object	Default value of the store	Source: undefined
deserializeFnName	string	Name of a deserialize function registered in the rust side plugin builder	Source: undefined
overrideDefaults	boolean	When creating the store, override the store with the on-disk state if it exists, ignoring defaults	Source: undefined
serializeFnName	string	Name of a serialize function registered in the rust side plugin builder	Source: undefined

Source: undefined

Functions

getStore()

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

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

Source: undefined

---

load()

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

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

Source: undefined