0.1.2 • Published 2 years ago

mocc-storage v0.1.2

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

mocc-storage

前端本地缓存库,支持本地缓存过期时间设置

class MoccWebStorage {
    private storage;
    private storageOptions;
    private usingKeyCase;
    constructor(options: StorageOptions);
    /**
     * 使用中的缓存key
     */
    get usingKeys(): string[];
    /**
     * 初始化
     */
    private init;
    /**
     * 自检清理过期缓存
     * @description 初始化时,会自检一次,如在某些场景需要可手动调用该方法自检
     * @returns needCleanKeys 清理的缓存key
     *
     */
    checkCleanSelf(): string[];
    /**
     * 处理包装缓存key
     * @param key 缓存key
     * @returns 包装缓存key
     */
    private processKey;
    /**
     * 处理包装缓存数据
     * @param data 缓存数据
     * @param options 缓存配置
     * @returns 包装缓存数据
     */
    private processValue;
    /**
     * 获取缓存数据
     * @param key 缓存key
     * @description 在获取的同时会校验缓存是否过期,过期数据会移除,反之返回数据
     * @returns 缓存数据
     */
    getItem(key: string): any;
    /**
     * 设置缓存数据
     * @param key 缓存key
     * @param value 缓存数据
     * @param options 缓存配置
     * @returns 设置是否成功
     */
    setItem(key: string, value: any, options: Options = {}): boolean;
    /**
     * 移除缓存数据
     * @param key 缓存key
     * @returns 移除是否成功
     */
    removeItem(key: string): boolean;
    /**
     * 清理缓存
     * @param isCleanAll 是否清理应用缓存器所有数据,而非当前实例缓存器
     * @returns 清理是否成功
     */
    clear(isCleanAll?: boolean): boolean;
}