@lostlz/cache-js v1.0.12

CacheJs

概述

一款简易版本地储存插件。

• 支持基本类型、及能够通过JSON.stringify序列化的对象
• 支持设置默认值和过期时间
• 支持设置key前缀
• 在web环境支持localStorage/sessionStorage
• 兼容微信小程序

安装

npm i @lostlz/cache-js -S

微信小程序安装完需要构建npm

示例

web环境和小程序环境调用方式相同。

CacheJs

持久化缓存，对应localStorage。

import CacheJs from "@lostlz/cache-js";

// 写入一个对象缓存
CacheJs.set("obj1",{a:1,b:2,c:3});
// 写入一个对象并缓存一分钟
CacheJs.set("obj2",{a:1,b:2,c:3,d:4},new Date().getTime()+60*1000);
// 获取一个缓存,如果缓存不存在，或者超时返回{d:4}
const obj3 = CacheJs.get("obj3",{d:4});
console.log("obj3",obj3)

CacheJs.session

session缓存，对应sessionStorage。

小程序环境也可以使用，数据存在全局Map中，应用周期内都有效。

import CacheJs from "@lostlz/cache-js";

// 写入一个对象缓存
CacheJs.session.set("obj1",{a:1,b:2,c:3});
// 写入一个对象并缓存一分钟
CacheJs.session.set("obj2",{a:1,b:2,c:3,d:4},new Date().getTime()+60*1000);
// 获取一个缓存,如果缓存不存在，或者超时返回{d:4}
const obj3 = CacheJs.session.get("obj3",{d:4});
console.log("obj3",obj3)

方法

set(key,value,expire)

添加一个缓存,如果存在会覆盖。

参数：

• key：关键字（必填）
• value：需要存储的内容。支持基本类型、及能够通过JSON.stringify序列化的对象。（必填）
• expire：超过expire(时间戳/ms)清除缓存,默认永久。（非必填）

get(key,defaultValue)

获取一个缓存，如果缓存不存在，返回默认值.

参数：

• key：关键字。（必填）
• defaultValue：默认值，如果缓存不存在，返回此值。（非必填）

setPrefixKey(prefixKey)

设置key的前缀，如果设置，实际key=prefixKey+key

参数：

• prefixKey:前缀(必填)，默认为空

delete(key)

删除一个缓存

参数：

• key：关键字（必填）

clear()

清空全部缓存