@tauri-apps/plugin-store

类

LazyStore

由后端层持久化的延迟加载键值存储。

Implements

IStore

构造函数

new LazyStore()

new LazyStore(path, options?): LazyStore

请注意，如果其他人已经创建了存储，则不应用选项

参数

参数	类型	描述
`path`	`字符串`	存储的路径在 `app_data_dir` 中
`选项`?	`StoreOptions`	存储配置选项

LazyStore

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L96

方法

clear()

clear(): Promise<void>

清除存储，移除所有键值对。

注意：要清除存储并将其重置为其 default 值，请改用 reset。

Promise<void>

的实现

IStore.clear

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

close()

close(): Promise<void>

关闭存储并从内存中清除此资源。你不应再对此对象调用任何方法，并应放弃对它的任何引用。

Promise<void>

的实现

IStore.close

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L169

delete()

delete(key): Promise<boolean>

从存储中移除键值对。

参数

参数	类型	描述
`键`	`字符串`

Promise<boolean>

的实现

IStore.delete

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

entries()

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

返回存储中所有条目的列表。

类型参数

类型参数
`T`

Promise<[string, T][]>

的实现

IStore.entries

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

get()

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

返回给定 key 的值，如果键不存在则返回 undefined。

类型参数

类型参数
`T`

参数

参数	类型	描述
`键`	`字符串`

Promise<undefined | T>

的实现

IStore.get

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

has()

has(key): Promise<boolean>

如果给定 key 存在于存储中，则返回 true。

参数

参数	类型	描述
`键`	`字符串`

Promise<boolean>

的实现

IStore.has

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

init()

init(): Promise<void>

如果存储尚未加载，则初始化/加载存储

Promise<void>

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

keys()

keys(): Promise<string[]>

返回存储中所有键的列表。

Promise<string[]>

的实现

IStore.keys

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

length()

length(): Promise<number>

返回存储中键值对的数量。

Promise<number>

的实现

IStore.length

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

onChange()

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

监听存储中的更改。

类型参数

类型参数
`T`

参数

参数	类型	描述
`cb`	(`key`, `value`) => `void`

Promise<UnlistenFn>

一个解析为取消监听事件的函数的 Promise。

始于

2.0.0

的实现

IStore.onChange

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L163

onKeyChange()

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

监听存储键上的更改。

类型参数

类型参数
`T`

参数

参数	类型	描述
`键`	`字符串`
`cb`	(`value`) => `void`

Promise<UnlistenFn>

一个解析为取消监听事件的函数的 Promise。

始于

2.0.0

的实现

IStore.onKeyChange

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

reload()

reload(): Promise<void>

尝试将存储 path 处的磁盘状态加载到内存中。

如果磁盘状态由用户编辑，并且您想同步更改，此方法很有用。

注意：此方法不发出更改事件。

Promise<void>

的实现

IStore.reload

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

reset()

reset(): Promise<void>

将存储重置为其 default 值。

如果未设置默认值，此方法的行为与 clear 相同。

Promise<void>

的实现

IStore.reset

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

save()

save(): Promise<void>

将存储保存到存储 path 处的磁盘。

Promise<void>

的实现

IStore.save

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

set()

set(key, value): Promise<void>

将键值对插入到存储中。

参数

参数	类型	描述
`键`	`字符串`
`值`	`未知`

Promise<void>

的实现

IStore.set

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L108

values()

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

返回存储中所有值的列表。

类型参数

类型参数
`T`

Promise<T[]>

的实现

IStore.values

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

存储 (Store)

由后端层持久化的键值存储。

继承 (Extends)

资源

Implements

IStore

访问器

rid

get rid(): number

数字

继承自 (Inherited from)

资源.rid

来源: 未定义

方法

clear()

clear(): Promise<void>

清除存储，移除所有键值对。

注意：要清除存储并将其重置为其 default 值，请改用 reset。

Promise<void>

的实现

IStore.clear

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L259

close()

close(): Promise<void>

销毁并从内存中清理此资源。您不应再对此对象调用任何方法，并应放弃对它的任何引用。

Promise<void>

的实现

IStore.close

继承自 (Inherited from)

资源.close

来源: 未定义

delete()

delete(key): Promise<boolean>

从存储中移除键值对。

参数

参数	类型	描述
`键`	`字符串`

Promise<boolean>

的实现

IStore.delete

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L252

entries()

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

返回存储中所有条目的列表。

类型参数

类型参数
`T`

Promise<[string, T][]>

的实现

IStore.entries

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

get()

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

返回给定 key 的值，如果键不存在则返回 undefined。

类型参数

类型参数
`T`

参数

参数	类型	描述
`键`	`字符串`

Promise<undefined | T>

的实现

IStore.get

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

has()

has(key): Promise<boolean>

如果给定 key 存在于存储中，则返回 true。

参数

参数	类型	描述
`键`	`字符串`

Promise<boolean>

的实现

IStore.has

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

keys()

keys(): Promise<string[]>

返回存储中所有键的列表。

Promise<string[]>

的实现

IStore.keys

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

length()

length(): Promise<number>

返回存储中键值对的数量。

Promise<number>

的实现

IStore.length

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

onChange()

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

监听存储中的更改。

类型参数

类型参数
`T`

参数

参数	类型	描述
`cb`	(`key`, `value`) => `void`

Promise<UnlistenFn>

一个解析为取消监听事件的函数的 Promise。

始于

2.0.0

的实现

IStore.onChange

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L302

onKeyChange()

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

监听存储键上的更改。

类型参数

类型参数
`T`

参数

参数	类型	描述
`键`	`字符串`
`cb`	(`value`) => `void`

Promise<UnlistenFn>

一个解析为取消监听事件的函数的 Promise。

始于

2.0.0

的实现

IStore.onKeyChange

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

reload()

reload(): Promise<void>

尝试将存储 path 处的磁盘状态加载到内存中。

如果磁盘状态由用户编辑，并且您想同步更改，此方法很有用。

注意：此方法不发出更改事件。

Promise<void>

的实现

IStore.reload

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

reset()

reset(): Promise<void>

将存储重置为其 default 值。

如果未设置默认值，此方法的行为与 clear 相同。

Promise<void>

的实现

IStore.reset

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L263

save()

save(): Promise<void>

将存储保存到存储 path 处的磁盘。

Promise<void>

的实现

IStore.save

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

set()

set(key, value): Promise<void>

将键值对插入到存储中。

参数

参数	类型	描述
`键`	`字符串`
`值`	`未知`

Promise<void>

的实现

IStore.set

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L229

values()

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

返回存储中所有值的列表。

类型参数

类型参数
`T`

Promise<T[]>

的实现

IStore.values

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

get()

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

获取一个已加载的存储。

如果存储未加载，则返回 null。在这种情况下，您必须加载它。

当您已经知道存储已加载并且只需要访问其实例时，此函数更有用。否则请首选 Store.load。

参数

参数	类型	描述
`path`	`字符串`	存储的路径。

Promise<null | Store>

示例

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

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L223

load()

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

创建新的存储或加载具有路径的现有存储。

参数

参数	类型	描述
`path`	`字符串`	存储的路径在 `app_data_dir` 中
`选项`?	`StoreOptions`	存储配置选项

Promise<Store>

示例

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

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L196

类型别名 (Type Aliases)

StoreOptions

type StoreOptions: object;

创建存储的选项

类型声明

名称	类型	描述	定义于
`自动保存`	`boolean` \| `number`	修改时自动保存并带延迟时间（毫秒），默认是 100 毫秒，传入 `false` 禁用	来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L24
`创建新`	`布尔值 (boolean)`	强制创建新存储并带有默认值，即使它已经存在。	来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L36
`反序列化函数名`	`字符串`	在 Rust 侧插件构建器中注册的反序列化函数的名称	来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L32
`序列化函数名`	`字符串`	在 Rust 侧插件构建器中注册的序列化函数的名称	来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L28

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

函数

getStore()

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

获取一个已加载的存储。

如果存储未加载，则返回 null。在这种情况下，您必须加载它。

当您已经知道存储已加载并且只需要访问其实例时，此函数更有用。否则请首选 Store.load。

参数

参数	类型	描述
`path`	`字符串`	存储的路径。

Promise<Store | null>

示例

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

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L74

load()

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

创建新的存储或加载具有路径的现有存储。

参数

参数	类型	描述
`path`	`字符串`	存储的路径在 `app_data_dir` 中
`选项`?	`StoreOptions`	存储配置选项

Promise<Store>

示例

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

来源: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/store/guest-js/index.ts#L51

在 Open Collective 上支持在 GitHub 上赞助