For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/storage/getStorage.md.

getStorage

从本地缓存读取数据。

扫码预览

扫码预览 getStorage

使用限制

WARNING

Android、iOS:key 不存在时 Android 返回 null、iOS 返回 nil,且均按成功返回,不抛出错误;调用方按必返字段使用会得到 undefined,且无法区分「未写入」与「写入了空值」。

支持版本

前端库版本不低于 0.0.17。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片支持

使用说明

  • 写入时会对 data 做 JSON 序列化,读取时按 JSON 反序列化,无法解析时原样返回字符串。

调用方式

异步 API

getStorage<TData = unknown>(params: GetStorageParams): Promise<GetStorageResult<TData>>

入参

名称类型必填默认值约束说明
keystring是--本地缓存键名

调用示例

import { getStorage } from '@doubao-dev/framework/api';

const result = await getStorage<{ name: string; age: number }>({
  key: 'profile',
});

console.log(result.data.name, result.data.age);

成功返回

名称类型必返说明
dataTData是key 对应的数据。Android、iOS:key 不存在时 Android 返回 null、iOS 返回 nil,且均按成功返回,不抛出错误。

返回示例

{
  "data": {
    "name": "Tom",
    "age": 18
  }
}

错误处理

错误对象和通用错误码见 通用错误处理。

失败示例

{
  "errNo": 1600004,
  "errMsg": "key is empty"
}

错误码

errNoerrMsg平台触发条件处理建议
1600004key is emptyAndroid、iOSkey 为空字符串传入非空 key。
1600005key exceeds max lengthAndroid、iOSkey 长度超过 1024缩短 key 长度。

通用错误码

errNoerrMsg说明平台
102internal error内部错误Android