数据存储

接口声明

  1. { "name": "system.storage" }

导入模块

  1. import storage from '@system.storage' 或 const storage = require('@system.storage')

接口定义

方法

storage.get(OBJECT)

读取存储内容

参数：
参数名类型必填说明
keyString是索引
defaultString否如果 key 不存在，返回 default。如果 default 未指定，返回长度为 0 的空字符串
successFunction否成功回调
failFunction否失败回调
completeFunction否执行结束后的回调
success 返回值：

key 对应的存储内容

示例：
  1. storage.get({
  2.   key: 'A1',
  3.   success: function(data) {
  4.     console.log('handling success')
  5.   },
  6.   fail: function(data, code) {
  7.     console.log(`handling fail, code = ${code}`)
  8.   }
  9. })

storage.set(OBJECT)

修改存储内容

参数：
参数名类型必填说明
keyString是索引
valueString否新值。如果新值是长度为 0 的空字符串，会删除以 key 为索引的数据项
successFunction否成功回调
failFunction否失败回调
completeFunction否执行结束后的回调
示例：
  1. storage.set({
  2.   key: 'A1',
  3.   value: 'V1',
  4.   success: function(data) {
  5.     console.log('handling success')
  6.   },
  7.   fail: function(data, code) {
  8.     console.log(`handling fail, code = ${code}`)
  9.   }
  10. })

storage.clear(OBJECT)

清空存储内容

参数：
参数名类型必填说明
successFunction否成功回调
failFunction否失败回调
completeFunction否执行结束后的回调
示例：
  1. storage.clear({
  2.   success: function(data) {
  3.     console.log('handling success')
  4.   },
  5.   fail: function(data, code) {
  6.     console.log(`handling fail, code = ${code}`)
  7.   }
  8. })

storage.delete(OBJECT)

删除存储内容

参数：
参数名类型必填说明
keyString是索引
successFunction否成功回调
failFunction否失败回调
completeFunction否执行结束后的回调
示例：
  1. storage.delete({
  2.   key: 'A1',
  3.   success: function(data) {
  4.     console.log('handling success')
  5.   },
  6.   fail: function(data, code) {
  7.     console.log(`handling fail, code = ${code}`)
  8.   }
  9. })

storage.key(OBJECT) 1050+

返回存储中某个index的键名

参数：
参数名类型必填说明
indexNumber是要查询的键名对应的索引
successFunction否成功回调
failFunction否失败回调
completeFunction否执行结束后的回调
success 返回值：

index对应的键名

示例：
  1. storage.key({
  2.   index: 1,
  3.   success: function(data) {
  4.     console.log(`handling success, key = ${data}`)
  5.   },
  6.   fail: function(data, code) {
  7.     console.log(`handling fail, code = ${code}`)
  8.   }
  9. })

属性

名称参数类型是否可读是否可写描述
length 1050+　Number是否存储里的数据项的数量

示例：

  1. let length = storage.length

后台运行限制

无限制。后台运行详细用法参见后台运行 脚本。