/** * 将数据进行本地存储 * * @param {Object/Array} obj 待存储数据相关配置,可以是单个JSON对象,也可以是由多个JSON对象组成的数组 * @p-config {String} key 待存储数据的key,如:baidu.username * @p-config {String} value 待存储数据的内容 * @p-config {String} path cookie专用,默认为:根目录:"/",要设置到当前目录,则是:"./" * @p-config {String} domain cookie专用,默认为:当前域名 * @p-config {Number/Date} expires 数据的过期时间,可以是数字,单位是毫秒;也可以是日期对象,表示过期时间, * 如果未设置expires,或设置不合法时,组件会默认将其设置为30天 * @param {Boolean} enableUD 参数可选;是否在IE7及其以下版本中启用UserData,默认:false */
// 参数为JSON,且expires为数字类型 BrowserStorage.api.set({ "key" : "baidufe.author", "value" : "Alien", "expires" : 86400 // Number:(ms)有效期为一天 });
// 参数为JSON,且expires为日期类型 BrowserStorage.api.set({ "key" : "baidufe.author", "value" : "Alien", "expires" : new Date("2013-04-01") // Date:有效期到4月1日 });
// 参数为Array BrowserStorage.api.set([ { "key" : "baidufe.author", "value" : "Alien", "expires" : 86400 },{ "key" : "baidufe.username", "value" : "zxlie", "expires" : 86400 } ]);
// 参数为JSON,且expires为数字类型 BrowserStorage.api.set({ "key" : "baidufe.author", "value" : "Alien", "expires" : 86400 // Number:(ms)有效期为一天 },true); // 第二个参数设置为true即可,默认为false
/** * 将数据进行本地存储 * * @param {String/Object/Array} obj 待获取的存储数据相关配置,支持单个对象传入,同样也支持多个对象封装的数组格式 * @p-config {String} key 待存储数据的key * @param {Boolean} enableUD 参数可选;是否在IE7及其以下版本中启用UserData,默认:false * @return {Object/Array} 本地存储的数据,传入为单个对象时,返回单个对象;传入为数组时,返回为数组 */
// 参数为字符串 var value = BrowserStorage.api.get("baidufe.author"); // 如果获取到数据,结果类似:{key:"baidufe.author", value:"Alien"} // 如果没有获取到数据,结果类似:{key:"baidufe.author", value:null}
// 参数为JSON var value = BrowserStorage.api.get({ key : "baidufe.author" }); // 如果获取到数据,结果类似:{key:"baidufe.author", value:"Alien"} // 如果没有获取到数据,结果类似:{key:"baidufe.author", value:null}
// 参数为字符串,且提取多条数据 var value = BrowserStorage.api.get([ { key : "baidufe.author" },{ key : "baidufe.username" } ]); // 如果获取到数据,结果类似:[{key:"baidufe.author", value:"Alien"},{key:"baidufe.username", value:"zxlie"}] // 如果没有获取到数据,结果类似:[{key:"baidufe.author", value:null},{key:"baidufe.username", value:null}]
// 参数为字符串,且提取多条数据 var value = BrowserStorage.api.get({ key : "baidufe.author" },true); // 设置enableUD参数为true即可 // 如果获取到数据,结果类似:{key:"baidufe.author", value:"Alien"} // 如果没有获取到数据,结果类似:{key:"baidufe.author", value:null}
/** * 移除本地存储的数据 * * @param {String/Object/Array} obj 待移除的存储数据相关配置,支持移除某一个本地存储,也支持数组形式的批量移除 * @p-config {String} key 待移除数据的key * @p-config {String} path cookie专用,默认为:根目录:"/",要设置到当前目录,则是:"./" * @p-config {String} domain cookie专用,默认为:当前域名 * @param {Boolean} enableUD 参数可选;是否在IE7及其以下版本中启用UserData,默认:false */
// 参数为字符串 BrowserStorage.api.remove("baidufe.author");
// 参数为JSON BrowserStorage.api.remove({ key : "baidufe.author" });
// 参数为字符串,且提取多条数据 BrowserStorage.api.remove([ { key : "baidufe.author" },{ key : "baidufe.username" } ]);
// 参数为字符串,且提取多条数据 BrowserStorage.api.get({ key : "baidufe.author" },true); // 设置enableUD参数为true即可
/** * 清除所有本地存储的数据 * * @param {Boolean} enableUD 参数可选;是否在IE7及其以下版本中启用UserData,默认:false */
// 清空全部数据 BrowserStorage.api.clearAll();
/** * 移除本地存储的数据 * * @param {Boolean} enableUD 参数可选;是否在IE7及其以下版本中启用UserData,默认:false * @return {Array} 所有的key */
// 提取全部本地存储key var keys = BrowserStorage.api.getAllKeys(); // 数据返回格式如:["baidufe.author", "baidufe.username"] // 如果没有本地存储的数据,返回空数组,如:[]