将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理,否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB,所有数据存储上限为 10MB。
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
key | String | 是 | 本地缓存中指定的 key | |
data | any | 是 | 需要存储的内容。只支持原生类型、Date、及能够通过 JSON.stringify 序列化的对象。 | |
encrypt | Boolean | false | 是 | 是否开启加密存储。只有异步的 getStorage 接口支持开启加密存储。开启后,将会对 data 使用 AES128 解密,接口回调耗时将会增加。若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true |
success | Function | 否 | 接口调用成功的回调函数 | |
fail | Function | 否 | 接口调用失败的回调函数 | |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
从本地缓存中异步获取指定 key 的内容。
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
key | String | 是 | 本地缓存中指定的 key | |
encrypt | Boolean | false | 是 | 是否开启加密存储。只有异步的 getStorage 接口支持开启加密存储。开启后,将会对 data 使用 AES128 解密,接口回调耗时将会增加。若开启加密存储,setStorage 和 getStorage 需要同时声明 encrypt 的值为 true |
success | Function | 否 | 接口调用成功的回调函数 | |
fail | Function | 否 | 接口调用失败的回调函数 | |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
属性 | 类型 | 说明 |
---|---|---|
data | any | key 对应的内容 |
// 开启加密存储
qg.setStorage({
key: "key",
data: "value",
success() {
qg.getStorage({
key: "key",
success(res) {
console.log(res.data);
}
});
}
});
清理本地数据缓存。
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
success | Function | 否 | 接口调用成功的回调函数 | |
fail | Function | 否 | 接口调用失败的回调函数 | |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
try {
qg.clearStorage({
success(res) {
console.log(res);
},
fail(res) {
console.log(res);
},
complete(res) {
console.log(res);
}
});
} catch (e) {
// Do something when catch error
}
从本地缓存中移除指定 key。
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
key | String | 是 | 本地缓存中指定的 key | |
success | Function | 否 | 接口调用成功的回调函数 | |
fail | Function | 否 | 接口调用失败的回调函数 | |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
try {
qg.removeStorage({
key:'key',
success(res) {
console.log(res)
},
fail(res) {
console.log(res)
},
complete(res) {
console.log(res)
},
})
} catch (e) {
// Do something when catch error
}
将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理,否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB,所有数据存储上限为 10MB。
本地缓存中指定的 key
需要存储的内容。只支持原生类型、Date、及能够通过 JSON.stringify 序列化的对象。
注意 storage 应只用来进行数据的持久化存储,不应用于运行时的数据传递或全局状态管理。启动过程中过多的同步读写存储,会显著影响启动耗时
try {
qg.setStorageSync("key", "value");
} catch (e) {}
从本地缓存中同步获取指定 key 的内容。
本地缓存中指定的 key
key 对应的内容
注意 storage 应只用来进行数据的持久化存储,不应用于运行时的数据传递或全局状态管理。启动过程中过多的同步读写存储,会显著影响启动耗时
try {
var value = qg.getStorageSync("key");
if (value) {
// Do something with return value
}
} catch (e) {
// Do something when catch error
}
qg.clearStorage 的同步版本
try {
qg.clearStorageSync();
} catch (e) {
// Do something when catch error
}
qg.removeStorage 的同步版本
本地缓存中指定的 key
try {
qg.removeStorageSync("key");
} catch (e) {
// Do something when catch error
}
异步获取当前 storage 的相关信息。
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
success | Function | 否 | 接口调用成功的回调函数 | |
fail | Function | 否 | 接口调用失败的回调函数 | |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
属性 | 类型 | 说明 |
---|---|---|
keys | Array | 当前 storage 中所有的 key |
currentSize | Number | 当前占用的空间大小,单位 KB |
limitSize | Number | 限制的空间大小,单位 KB |
qg.getStorageInfo({
success(res) {
console.log(res.keys);
console.log(res.currentSize);
console.log(res.limitSize);
}
});
qg.getStorageInfo 的同步版本
Object object
属性 | 类型 | 说明 |
---|---|---|
keys | Array | 当前 storage 中所有的 key |
currentSize | Number | 当前占用的空间大小,单位 KB |
limitSize | Number | 限制的空间大小,单位 KB |
try {
const res = qg.getStorageInfoSync();
console.log(res.keys);
console.log(res.currentSize);
console.log(res.limitSize);
} catch (e) {
// Do something when catch error
}