react-ngwlan-storage v0.0.1-beta5

react-ngwlan-storage

react H5 浏览器缓存组件,包括 cookie、localStorage、sessionStorage 等相关存取API

install

npm i react-ngwlan-storage --D

import

import Storage from 'react-ngwlan-storage';

cookie api

1.添加cookie

Storage.saveCookie(key,value,opt);

2.获取指定cookie

Storage.getCookie(key,doNotParse);

3.删除指定cookie

Storage.removeCookie(key,opt);

参数说明

• opt参数中可选填的内容如下

• masAge补充说明：

• 如果max-age属性为正数，则表示该cookie会在max-age秒之后自动失效。浏览器会将max-age为正数的cookie持久化，即写到对应的cookie文件中。无论客户关闭了浏览器还是电脑，只要还在max-age秒之前，登录网站时该cookie仍然有效；

• 如果max-age为负数，则表示该cookie仅在本浏览器窗口以及本窗口打开的子窗口内有效，关闭窗口后该cookie即失效。max-age为负数的Cookie，为临时性cookie，不会被持久化，不会被写到cookie文件中。cookie信息保存在浏览器内存中，因此关闭浏览器该cookie就消失了。cookie默认的max-age值为-1；

• 如果max-age为0，则表示删除该cookie。cookie机制没有提供删除cookie的方法，因此通过设置该cookie即时失效实现删除cookie的效果。失效的Cookie会被浏览器从cookie文件或者内存中删除；

• 如果不设置expires或者max-age这个cookie默认是Session的，也就是关闭浏览器该cookie就消失了。

localStorage api

参数说明

• key: 字符串类型，本地数据标识，通过key获取/删除指定的本地数据，必选
• value: 字符串、数组、对象类型，本地数据标识对应的值，必选

1.添加localStorage

Storage.saveLocalStorage(key,value);

2.获取指定localStorage

Storage.getLocalStorage(key);

3.判断是否有指定的localStorage

Storage.haveLocalStorage(key);

4.删除单个localStorage

Storage.removeLocalStorage(key);

5.删除全部localStorage

Storage.removeAllLocalStorage();

6.获取全部localStorage

Storage.getAllLocalStorage();

7.获取存储的local storage数量

Storage.getLocalStorageNum();

sessionStorage api

参数说明

• key: 字符串类型，本地数据标识，通过key获取/删除指定的本地数据，必选
• value: 字符串、数组、对象类型，本地数据标识对应的值，必选

1.添加sessionStorage

Storage.saveSession(key,value);

2.获取指定sessionStorage

Storage.getSession(key);

3.判断是否有指定的sessionStorage

Storage.haveSession(key);

4.删除指定sessionStorage

Storage.removeSession(key);

5.删除全部sessionStorage

Storage.removeAllSession();

6.获取全部sessionStorage

Storage.getAllSession();

7.获取存储的sessionStorage的数量

Storage.getSessionNum();

example

cookie

import Storage from 'react-ngwlan-storage';

Storage.saveCookie('userId', '100100');
Storage.getCookie('userId');
Storage.removeCookie('userId',);

localStorage

import Storage from 'react-ngwlan-storage';

Storage.saveLocalStorage('test', 123);
Storage.getLocalStorage('test');  // 123
Storage.getLocalStorageNum();  // 1
Storage.getAllLocalStorage();  // {'test':123}
Storage.haveLocalStorage('test');  // true
Storage.removeLocalStorage('test');
Storage.removeAllLocalStorage();

sessionStorage

import Storage from 'react-ngwlan-storage';

Storage.saveSession('test', 123);
Storage.getSession('test');  // 123
Storage.getSessionNum();  // 1
Storage.getAllSession();  // {'test':123}
Storage.haveSession('test');  // true
Storage.removeSession('test');
Storage.removeAllSession();