lsy-storages 插件的使用方法

序

这是一个关于浏览器web storage存储（cookie，sessionStorage，localStorage）的npmjs插件，它增加并完善了原有API功能。该插件融合了LsyCookie, LsySession, LsyStorage 三个插件的所有功能。

lsy-storages 在webpack+es6开发环境下的使用方法

安装

$ npm install lsy-storages --save

模块导入

注意：为了避免跟浏览器原有API产生耦合，最好进行重命名处理。

import {
    localStorage as LsyStorage,
    sessionStorage as LsySession,
    cookie as LsyCookie
} from 'lsy-storages';

LsyCookie部分

主要方法有：

//cookie名称key，值val,过期时间time(单位s), path路径
LsyCookie.setItem(key[string], val[string|object], time[number], path[string])

//通过cookie名称获取
LsyCookie.getItem(key[string])

//获取所有cookie
LsyCookie.getAll()

//通过cookie名称删除, path为路径（默认为当前路径）
LsyCookie.removeItem(key[string], path[string:default('./')])

//删除所有cookie
LsyCookie.clear()

LsySession部分

//设置sessionStorage信息，key为记录名称（字符串），value为字（可以是字符串或者对象）
LsySession.setItem(key[string], value[string|object])

//设置sessionStorage信息，prex为记录前缀名（字符串），values为需要存储的信息集合（数组），byId表示是否以被存储对象的ID为后缀名或者说为下标（boolean)
LsySession.setArr(prex[string], values[array], byId[boolean])

//通过数组与数组映射的方式存储信息，要求两数组长度相等，且keys内部元素为字符串类型
LsySession.setList(keys[array], values[array])

//通过记录名称获取sessionStorage信息
LsySession.getItem(key[string])

//通过记录名称集合（数组）获取sessionStorage信息，结果为数组
LsySession.getItemsByKeys(keys[array])

//通过匹配记录名称获取sessionStorage信息，结果为数组
LsySession.getArr(prex[string])

//通过记录名称删除sessionStorage信息
LsySession.removeItem(key[string])

//删除所有记录
LsySession.clear()

LsyStorage部分

//设置localStorage信息，key为记录名称（字符串），value为字（可以是字符串或者对象）
LsyStorage.setItem(key[string], value[string|object])

//设置localStorage信息，prex为记录前缀名（字符串），values为需要存储的信息集合（数组），byId表示是否以被存储对象的ID为后缀名或者说为下标（boolean)
LsyStorage.setArr(prex[string], values[array],byId[boolean])

//通过数组与数组映射的方式存储信息，要求两数组长度相等，且keys内部元素为字符串类型
LsyStorage.setList(keys[array], values[array])

//通过记录名称获取localStorage信息
LsyStorage.getItem(key[string])

//通过记录名称集合（数组）获取localStorage信息，结果为数组
LsyStorage.getItemsByKeys(keys[array])

//通过匹配记录名称获取localStorage信息，结果为数组
LsyStorage.getArr(prex[string])

//通过记录名称删除localStorage信息
LsyStorage.removeItem(key[string])

//删除所有记录
LsyStorage.clear()