@ 电容器/ 存储器

存储API为轻量级数据提供了一个简单的密钥/值持续存储.

移动操作系统可定期清除下列数据: window.localStorage,所以这个 应使用API。 此 API 将返回使用 localStorage 当运行为进步Web App.

此插件将使用 UserDefaults 在iOS和 SharedPreferences 安卓号 如果应用程序未安装, 则清除存储数据 .

说明: 这个 API 是 没有 打算用作本地数据库。 如果你的应用 存储大量数据,有高读/写负载,或需要复杂的查询, 我们建议看看基于SQLite的解决方案. 这种解决办法之一是: 离子安全存储,一个基于 SQLite 的引擎,具有全加密支持. 这个 社区 还建造了多台其他存储引擎.

安装

npm install @capacitor/storage
npx cap sync

示例

import { Storage } from '@capacitor/storage';

const setName = async () => {
  await Storage.set({
    key: 'name',
    value: 'Max',
  });
};

const checkName = async () => {
  const { value } = await Storage.get({ key: 'name' });

  console.log(`Hello ${value}!`);
};

const removeName = async () => {
  await Storage.remove({ key: 'name' });
};

与JSON合作

存储 API 只支持字符串值 。 不过,如果你 JSON.stringify 调用前的对象 set(),则 JSON.parse 从 get()。 。 。 .

这种方法也可用于存储非字符串值,例如数字和布尔.

API 密码

• configure(...)
• get(...)
• set(...)
• remove(...)
• clear()
• keys()
• migrate()
• removeOld()
• 接口

配置(...)

configure(options: ConfigureOptions) => Promise<void>

在运行时配置存储插件 .

选项 undefined 将不使用.

自: 1.0.0 (单位:千美元)

获取(...)

get(options: GetOptions) => Promise<GetResult>

从给定密钥的存储中获取值 .

回返情况: Promise<GetResult>

自: 1.0.0 (单位:千美元)

设置(...)

set(options: SetOptions) => Promise<void>

为给定的密钥设置存储值 .

自: 1.0.0 (单位:千美元)

删除(...)

remove(options: RemoveOptions) => Promise<void>

删除给定密钥存储中的值( 如果有 ) .

自: 1.0.0 (单位:千美元)

清除( c)

clear() => Promise<void>

从存储中清除密钥和值 .

自: 1.0.0 (单位:千美元)

键( )

keys() => Promise<KeysResult>

返回存储中的已知密钥列表 .

回返情况: Promise<KeysResult>

自: 1.0.0 (单位:千美元)

迁移( )

migrate() => Promise<MigrateResult>

从 Capacitor 2 存储插件迁移数据.

这一行动是无损的。 它不会删除旧数据,只会 如果密钥尚未设置, 请写入新数据 . 要删除迁移后的旧数据, 请调用 removeOld () .

回返情况: Promise<MigrateResult>

自: 1.0.0 (单位:千美元)

删除旧( C)

removeOld() => Promise<void>

删除旧数据 _cap_ 前缀来自 Capacitor 2 存储插件.

自: 1.1.0 国家

接口

配置选项

获取恢复

获取选项

设置选项

删除选项

密钥结果

迁移结果