1.0.3 • Published 5 years ago

serialize-storage v1.0.3

Weekly downloads
3
License
ISC
Repository
github
Last release
5 years ago

SerializeStorage

做什么的

可以更简单的获取和存储各种以键值对存储的Storage,如localStorage。

如何使用

// 引入
import SerializeStorage from 'serialize-storage'
// 创建实例
const storage = new SerializeStorage(localStorage, {
  // 自动保存,默认为false,可以在getItem覆盖设置
  autoSave: false
  // 内置键前缀,建议不更改
  // keyPrefix: ''
})
// 获取数据
let item = storage.getItem('test')
// 设置和读取
console.log(item.value)
item.value = 4
// 默认需要手动保存
item.save()
// 移除
item.remove()
// 复杂的键
item = storage.getItem('test.test.1')
// 用实例而不是数据项来设置
storage.setItem('test', '')
// 在chrome扩展中可以使用异步版本
await storage.getItemAsync('test')

更多细节请参考测试用例

TODO

  • 加入对chrome storage的异步支持
  • 完善声明文件
  • 加入过期时间选项
  • update方法