开发
API

tt.getStorageInfo

基础库 1.0.0 开始支持本方法。

异步获取本地缓存数据的相关信息。

语法

tt.getStorageInfo([options])

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
successfunction接口调用成功的回调函数1.0.0
failfunction接口调用失败的回调函数1.0.0
completefunction接口调用结束的回调函数(调用成功、失败都会执行),回调参数同成功或失败回调1.0.0

回调成功

Object 类型,属性如下:

属性类型说明最低支持版本
errMsgstring"getStorageInfo:ok"1.0.0
keysstring[]本地数据缓存中的所有键名列表,如本地数据则返回空数组1.0.0
currentSizenumber当前占用的空间大小,以 KB 为单位1.0.0
limitSizenumber存储空间上限,以 KB 为单位,一般来说会返回 102401.0.0

回调失败

Object 类型,属性如下:

属性类型说明最低支持版本
errMsgstring"getStorageInfo:fail " + 详细错误信息1.28.0

效果示例

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

预期表现:

  • 无回调参数情况,没有提示,无返回值。
  • 有回调参数情况,读取本地存储的相关信息并给予成功或失败提示。
<!-- index.ttml -->
<button type="primary" bindtap="setStorage">setStorage</button>
<button type="primary" bindtap="getStorageInfo">getStorageInfo(无参数)</button>
<button type="primary" bindtap="getStorageInfoCb">getStorageInfo(有回调参数)</button>
// index.js
Page({
  setStorage() {
    tt.setStorage({
      key: "test_key",
      data: "byteDance",
      success: (res) => {
        tt.showToast({ title: "存储成功" });
      },
      fail: (err) => {
        tt.showModal({
          title: "存储失败",
          content: err.errMsg,
          showCancel: false,
        });
      },
      complete: (res) => console.log("存储完成"),
    });
  },
  getStorageInfo() {
    tt.getStorageInfo();
  },
  getStorageInfoCb() {
    tt.getStorageInfo({
      success: (res) => {
        console.log("getStorageInfo调用成功", res);
        tt.showModal({
          title: "读取成功",
          content: `当前storage所有的key:${JSON.stringify(res.keys)}`,
        });
      },
      fail: (err) => {
        tt.showModal({
          title: "读取失败",
          content: err.errMsg,
          showCancel: false,
        });
      },
      complete: (res) => console.log("读取完成"),
    });
  },
});

Bug & Tip

暂无

点击纠错
评价此篇文档