js-storages
v1.1.0
Published
html5、localStorage、sessionStorage...
Downloads
8
Maintainers
Readme
js-storages
js-storages
是一个封装了localStorage
、sessionStorage
、Cookie
对象的方法的JavaScript
库。使用js-storages
你可以简单、方便的对本地存储进行操作。
安装
npm install js-storages --save-dev
yarn add js-storages
使用
import storages from 'js-storages'
storages.JSLocalStorage.set('key', 'value')
storages.JSLocalStorage.get('key')
storages.JSSessionStorage.set('key', 'value')
storages.JSSessionStorage.get('key')
storages.JSCookie.set('key', 'value', {
" : 1000*60*60*24*30,
" path: '/',
" domain: 'www.baidu.com',
" secure: true
})
storages.JSCookie.get('key')
你也可以导入指定指定模块后再进行操作
import { JSLocalStorage, JSSessionStorage, JSCookie } from 'js-storages'
具体方法
localStorage
、sessionStorage
HTML5
提供的localStorage
和sessionStorage
对象的API
十分类似,只是在对值保存的生命周期上有所不同:网址链接,所以对localStorage
和sessionStorage
封装的API
是相同的。
1、set
在Storage
中存储指定的值
语法:
JSLocalStorage.set(key, value[, time[, callback]])
参数:
key (必须,string
)
所存储值的键
value (必须,string | object | any[] | number
)
存储的值
time(可选,number
)
存储值的过期时间,单位毫秒
callback(可选,Function
)
执行成功的回调函数
2、get
获取Storage
中指定的值。
语法
JSLocalStorage.get(key[, callback])
参数
key (必须,string
)
根据key
从Storage
中获取对应的值。
callback(可选,Function
)
执行成功的回调函数
3、remove
删除Storage
中指定的值。
语法
JSLocalStorage.remove(key)
参数
key (必须,string
)
根据key
值从Storage
中删除指定的值。
4、removeAll
删除Storage
中所有的值。
语法
JSLocalStorage.removeAll()
5、has
判断Storage
中是否含有某个值。
语法
JSLocalStorage.has(key)
参数
key (必须,string
)
根据key
值判断Storage
中存在某个键
6、keys
获取Storage
中所有的键。
语法
JSLocalStorage.keys()
cookie
1、set
语法:
JSCookie.set('test', 'value', {
path: '/',
expries: 1000 * 60
})
参数:
key [string
]
必填字段,不能是:path
、expires
、domain
等字段。
value [any
]
必填字段,存储的值
args [object
]
可选字段,额外的配置信息,包括path
、expires
、domain
、secure
。
"expires": "cookie过期时间",
"path": "cookie存储的路径",
"domain": "cookie存储的域名",
"secure": "cookie只通过https协议传输"
2、get
获取某个cookie的value。
语法:
JSCookie.get('key')
参数:
key [string
]
必填字段。
3、has
判断是否存储有某个cookie。
语法:
JSCookie.has('key')
参数:
key [string
]
必填字段
4、remove
清除某个cookie
语法:
JSCookie.remove('key')
参数:
key [string
]
必填字段
5、removeAll
清除所有cookie
语法:
JSCookie.removeAll()
6、keys
获取所有cookie的key,并以数组的形式返回。
语法:
JSCookie.keys()