1Introduction
- description:storage for localStorage/sessionStorage
- author:ydr.me
- create:2016年11月26日16:39:19
- update:2016年11月26日16:39:19
- github:https://github.com/blearjs/blear.core.storage
2Example
var storage = require('blear.core.storage');
3storage(store): storageAPI
对 store
的一层封装,封装的接口详细参考静态方法。
store
必须具备以下方法:
- 获取项目:
.getItem(key): val
- 设置项目:
.setItem(key, val)
- 移除项目:
.removeItem(key)
- 根据索引值去键:
.key(index)
- 清空项目:
.clear()
- 项目长度:
.length
key
、val
都必须为字符串。
4Static
4.1.local
本地永久性存储接口封装。
4.1.1.get(key): val
取值。
local.get('user');
// => {
// userName: "cloudcome"
// }
4.1.1.1key
- 类型:
String
- 说明:键名
4.1.1.2val
- 类型:
Array | Object | Boolean | Number | String | null
- 说明:键值
4.1.2.set(key, val): success
设值。
local.set('user', {
userName: 'Tom lee'
});
// => true
4.1.2.1key
- 类型:
String
- 说明:键名
4.1.2.2val
- 类型:
Array | Object | Boolean | Number | String | null
- 说明:键值
4.1.2.3success
- 类型:
Boolean
- 说明:设置成功返回
true
,否则返回false
4.1.3.remove(key): success
移除某一个存储。
local.remove('user');
// => true
4.1.3.1key
- 类型:
String
- 说明:键名
4.1.3.2success
- 类型:
Boolean
- 说明:设置成功返回
true
,否则返回false
4.1.4.clear(): success
清空所有存储。
local.clear();
// => true
4.1.4.1success
- 类型:
Boolean
- 说明:设置成功返回
true
,否则返回false
4.1.5.keys(): keys
返回所有键。
4.1.5.1keys
- 类型:
Array
4.1.6.size(): size
返回存储键数量。
4.1.6.1size
- 类型:
Number
4.2.session
本地时效性存储接口封装。接口与 local
一致。