@tauri-apps/plugin-store

Clases

LazyStore

Un almacén clave-valor de carga diferida (lazy loaded) mantenido por la capa de backend.

Implementa

• IStore

Constructores

new LazyStore()

new LazyStore(path, options?): LazyStore

Ten en cuenta que las opciones no se aplican si alguien más ya creó el almacén (store)

Parámetros

Parámetro	Tipo	Descripción
path	string	Ruta para guardar el almacén (store) en app_data_dir
options?	StoreOptions	Opciones de configuración del almacén (store)

Devuelve

LazyStore

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

Métodos

clear()

clear(): Promise<void>

Limpia el almacén (store), eliminando todos los pares clave-valor.

Nota: Para limpiar el almacenamiento y restablecerlo a su valor predeterminado, usa reset en su lugar.

Devuelve

Promise<void>

Implementación de

IStore.clear

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

close()

close(): Promise<void>

Cierra el almacén (store) y limpia este recurso de la memoria. Ya no debes llamar a ningún método en este objeto y debes descartar cualquier referencia a él.

Devuelve

Promise<void>

Implementación de

IStore.close

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

delete()

delete(key): Promise<boolean>

Elimina un par clave-valor del almacén (store).

Parámetros

Parámetro	Tipo	Descripción
key	string

Devuelve

Promise<boolean>

Implementación de

IStore.delete

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

entries()

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

Devuelve una lista de todas las entradas en el almacén (store).

Parámetros de tipo

Parámetro de tipo
T

Devuelve

Promise<[string, T][]>

Implementación de

IStore.entries

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

get()

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

Devuelve el valor para la key dada o undefined si la clave no existe.

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
key	string

Devuelve

Promise<undefined | T>

Implementación de

IStore.get

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

has()

has(key): Promise<boolean>

Devuelve true si la key dada existe en el almacén (store).

Parámetros

Parámetro	Tipo	Descripción
key	string

Devuelve

Promise<boolean>

Implementación de

IStore.has

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

init()

init(): Promise<void>

Inicializa/carga el almacén (store) si aún no está cargado

Devuelve

Promise<void>

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

keys()

keys(): Promise<string[]>

Devuelve una lista de todas las claves en el almacén (store).

Devuelve

Promise<string[]>

Implementación de

IStore.keys

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

length()

length(): Promise<number>

Devuelve el número de pares clave-valor en el almacén (store).

Devuelve

Promise<number>

Implementación de

IStore.length

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

onChange()

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

Escucha cambios en el almacén (store).

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
cb	(key, value) => void

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar el evento.

Desde

2.0.0

Implementación de

IStore.onChange

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

onKeyChange()

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

Escucha cambios en una clave del almacén (store).

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
key	string
cb	(value) => void

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar el evento.

Desde

2.0.0

Implementación de

IStore.onKeyChange

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

reload()

reload(options?): Promise<void>

Intenta cargar el estado en disco en la path del almacén en la memoria.

Este método es útil si el estado en disco fue editado por el usuario y quieres sincronizar los cambios.

Nota:

• Este método carga los datos y los combina con el almacén actual, este comportamiento se cambiará para restablecer primero a los valores por defecto y luego combinar con el estado en disco en la v3, para hacer que el almacén coincida completamente con el estado en disco, establece ignoreDefaults en true
• Este método no emite eventos de cambio.

Parámetros

Parámetro	Tipo
options?	ReloadOptions

Devuelve

Promise<void>

Implementación de

IStore.reload

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

reset()

reset(): Promise<void>

Restablece el almacén (store) a su valor predeterminado.

Si no se ha establecido un valor predeterminado, este método se comporta de forma idéntica a clear.

Devuelve

Promise<void>

Implementación de

IStore.reset

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

save()

save(): Promise<void>

Guarda el almacén (store) en el disco en la path del almacén.

Devuelve

Promise<void>

Implementación de

IStore.save

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

set()

set(key, value): Promise<void>

Inserta un par clave-valor en el almacén (store).

Parámetros

Parámetro	Tipo	Descripción
key	string
value	unknown

Devuelve

Promise<void>

Implementación de

IStore.set

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

values()

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

Devuelve una lista de todos los valores en el almacén (store).

Parámetros de tipo

Parámetro de tipo
T

Devuelve

Promise<T[]>

Implementación de

IStore.values

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

---

Store

Un almacén clave-valor mantenido por la capa de backend.

Extiende

• Resource

Implementa

• IStore

Accesores

rid

get rid(): number

Devuelve

number

Heredado de

Resource.rid

Origen: undefined

Métodos

clear()

clear(): Promise<void>

Limpia el almacén (store), eliminando todos los pares clave-valor.

Nota: Para limpiar el almacenamiento y restablecerlo a su valor predeterminado, usa reset en su lugar.

Devuelve

Promise<void>

Implementación de

IStore.clear

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

close()

close(): Promise<void>

Destruye y limpia este recurso de la memoria. Ya no deberías llamar a ningún método de este objeto y deberías descartar cualquier referencia a él.

Devuelve

Promise<void>

Implementación de

IStore.close

Heredado de

Resource.close

Origen: undefined

delete()

delete(key): Promise<boolean>

Elimina un par clave-valor del almacén (store).

Parámetros

Parámetro	Tipo	Descripción
key	string

Devuelve

Promise<boolean>

Implementación de

IStore.delete

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

entries()

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

Devuelve una lista de todas las entradas en el almacén (store).

Parámetros de tipo

Parámetro de tipo
T

Devuelve

Promise<[string, T][]>

Implementación de

IStore.entries

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

get()

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

Devuelve el valor para la key dada o undefined si la clave no existe.

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
key	string

Devuelve

Promise<undefined | T>

Implementación de

IStore.get

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

has()

has(key): Promise<boolean>

Devuelve true si la key dada existe en el almacén (store).

Parámetros

Parámetro	Tipo	Descripción
key	string

Devuelve

Promise<boolean>

Implementación de

IStore.has

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

keys()

keys(): Promise<string[]>

Devuelve una lista de todas las claves en el almacén (store).

Devuelve

Promise<string[]>

Implementación de

IStore.keys

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

length()

length(): Promise<number>

Devuelve el número de pares clave-valor en el almacén (store).

Devuelve

Promise<number>

Implementación de

IStore.length

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

onChange()

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

Escucha cambios en el almacén (store).

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
cb	(key, value) => void

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar el evento.

Desde

2.0.0

Implementación de

IStore.onChange

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

onKeyChange()

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

Escucha cambios en una clave del almacén (store).

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo	Descripción
key	string
cb	(value) => void

Devuelve

Promise<UnlistenFn>

Una promesa que se resuelve en una función para dejar de escuchar el evento.

Desde

2.0.0

Implementación de

IStore.onKeyChange

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

reload()

reload(options?): Promise<void>

Intenta cargar el estado en disco en la path del almacén en la memoria.

Este método es útil si el estado en disco fue editado por el usuario y quieres sincronizar los cambios.

Nota:

• Este método carga los datos y los combina con el almacén actual, este comportamiento se cambiará para restablecer primero a los valores por defecto y luego combinar con el estado en disco en la v3, para hacer que el almacén coincida completamente con el estado en disco, establece ignoreDefaults en true
• Este método no emite eventos de cambio.

Parámetros

Parámetro	Tipo
options?	ReloadOptions

Devuelve

Promise<void>

Implementación de

IStore.reload

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

reset()

reset(): Promise<void>

Restablece el almacén (store) a su valor predeterminado.

Si no se ha establecido un valor predeterminado, este método se comporta de forma idéntica a clear.

Devuelve

Promise<void>

Implementación de

IStore.reset

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

save()

save(): Promise<void>

Guarda el almacén (store) en el disco en la path del almacén.

Devuelve

Promise<void>

Implementación de

IStore.save

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

set()

set(key, value): Promise<void>

Inserta un par clave-valor en el almacén (store).

Parámetros

Parámetro	Tipo	Descripción
key	string
value	unknown

Devuelve

Promise<void>

Implementación de

IStore.set

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

values()

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

Devuelve una lista de todos los valores en el almacén (store).

Parámetros de tipo

Parámetro de tipo
T

Devuelve

Promise<T[]>

Implementación de

IStore.values

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

get()

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

Obtiene un almacén (store) ya cargado.

Si el almacén (store) no está cargado, devuelve null. En este caso debes usar load para cargarlo.

Esta función es más útil cuando ya sabes que el almacén (store) está cargado y solo necesitas acceder a su instancia. De lo contrario, prefiere Store.load.

Parámetros

Parámetro	Tipo	Descripción
path	string	Ruta del almacén (store).

Devuelve

Promise<null | Store>

Ejemplo

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

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

load()

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

Crea un nuevo Store o carga el almacén existente con la ruta.

Parámetros

Parámetro	Tipo	Descripción
path	string	Ruta para guardar el almacén (store) en app_data_dir
options?	StoreOptions	Opciones de configuración del almacén (store)

Devuelve

Promise<Store>

Ejemplo

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

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

Alias de tipos

ReloadOptions

type ReloadOptions: object;

Opciones para IStore.reload de un IStore

Declaración de tipo

Nombre	Tipo	Descripción	Definido en
ignoreDefaults	boolean	Para que el almacén coincida completamente con el estado en disco, ignorando los valores por defecto	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L461

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

---

StoreOptions

type StoreOptions: object;

Opciones para crear un almacén (store)

Declaración de tipo

Nombre	Tipo	Descripción	Definido en
autoSave	boolean | number	Guardado automático al modificar con duración de debounce en milisegundos, por defecto es 100ms, pasa false para desactivarlo	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L28
createNew	boolean	Forzar la creación de un nuevo almacén (store) con valores por defecto incluso si ya existe.	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L40
defaults	object	Valor por defecto del almacén (store)	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L24
deserializeFnName	string	Nombre de una función de deserialización registrada en el constructor del plugin del lado de Rust	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L36
overrideDefaults	boolean	Al crear el almacén, sobrescribir el almacén con el estado en disco si existe, ignorando los valores por defecto	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L44
serializeFnName	string	Nombre de una función de serialización registrada en el constructor del plugin del lado de Rust	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L32

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

Funciones

getStore()

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

Obtiene un almacén (store) ya cargado.

Si el almacén (store) no está cargado, devuelve null. En este caso debes usar load para cargarlo.

Esta función es más útil cuando ya sabes que el almacén (store) está cargado y solo necesitas acceder a su instancia. De lo contrario, prefiere Store.load.

Parámetros

Parámetro	Tipo	Descripción
path	string	Ruta del almacén (store).

Devuelve

Promise<Store | null>

Ejemplo

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

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

---

load()

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

Crea un nuevo Store o carga el almacén existente con la ruta.

Parámetros

Parámetro	Tipo	Descripción
path	string	Ruta para guardar el almacén (store) en app_data_dir
options?	StoreOptions	Opciones de configuración del almacén (store)

Devuelve

Promise<Store>

Ejemplo

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

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