Skip to content

Latest commit

 

History

History
83 lines (69 loc) · 2.63 KB

readmeCN.md

File metadata and controls

83 lines (69 loc) · 2.63 KB

tz-storage

size license coverage github version npm version downloads

English

轻量的localStorage工具。

  • 无依赖
  • 支持任意类型的数据
  • 支持UMD
  • 支持JSON
  • 支持过期时间
  • 未压缩时不超过3kb

安装

npm

$ npm install tz-storage --save

浏览器

下载dist目录中的文件并导入

<script src="tz-storage.min.js"></script>

用法

检查兼容性:

storage.isSupported // 返回 true 或者 false

设置命名空间,storage 的 key 将统一变为 “namespace.key” 的形式

storage.namespace = 'mystorage'

统一设置取到空值时的返回值

storage.defaultValue = 'nothing' // 当使用get方法取到空值时,将返回 'nothing'

也可以用 config 来初始化配置(推荐)

storage.config({
  namespace: 'space', // 默认值: ''
  defaultValue: 'empty'
})

Set

你可以保存任意数据类型:

storage.set('key', {active: true, label: 'helloword'})
storage.set('key', [1, 2, 3, 4])
storage.set('key', 'hello')

设置过期时间,不设置则不会过期。如果取值时已经过期,则返回默认的或者由配置指定的空值:

storage.set('key', 'value', new Date().getTime() + 8640000)

Get

可以自定义空值:

storage.get('key', { defaultValue: 'empty' }) // 当取值为空或过期时,返回 'empty'

取值时指定返回值的类型(只对 String,Number,Boolean 类型有效):

storage.get('key', { type: 'number' }) // 取出的值将自动转为number类型

Remove

storage.get('key') // 删除指定的key