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/removeStorageSync.md.

removeStorageSync

删除本地缓存中指定 key 的数据。

扫码预览

扫码预览 removeStorageSync

支持版本

前端库版本不低于 0.0.19。

支持平台

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

支持场景

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

使用说明

  • key 不存在时删除操作也会成功返回。

调用方式

同步 API

removeStorageSync(params?: RemoveStorageParams): object

入参

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

调用示例

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

removeStorageSync({ key: 'profile' });

返回值

同步删除完成后返回。

错误处理

同步调用失败时抛出错误。错误对象和通用错误码见 通用错误处理。

失败示例

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

错误码

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

通用错误码

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