xframelib/dist/utils/WebCacheTool.d.ts

The accumulated front-end development foundation library originates from projects and serves projects.

import { LRUCache } from 'lru-cache';
declare class WebCacheTool {
    static defaultOptions: {
        max: number;
        ttl: number;
    };
    /**
     * 当前默认集合对象
     */
    static readonly cache: LRUCache<{}, {}, unknown>;
    static createCache(options?: any): LRUCache<{}, {}, unknown>;
    /**
     * 加入缓存
     * @param key
     * @param value
     * @param cacheObj
     * @returns
     */
    static set(key: string, value: any, cacheObj?: any): void;
    /**
     * 获取某个缓存值
     * @param key
     * @param cacheObj
     * @returns
     */
    static get(key: string, cacheObj?: any): any;
    /**
     * 删除某KEY的缓存
     * @param key
     * @param cacheObj
     * @returns
     */
    static remove(key: string, cacheObj?: any): boolean;
    /**
     * 是否包含某个KEY
     * @param key
     * @param cacheObj
     * @returns
     */
    static has(key: string, cacheObj?: any): boolean;
    /**
     * 获取已经存储的个数
     * @param cacheObj
     * @returns
     */
    static count(cacheObj?: any): number;
    /**
     * 最大数量
     * @param cacheObj
     * @returns
     */
    static maxSize(cacheObj?: any): number;
    /**
     * 获取缓存，但不更新时间
     * @param key
     * @param cacheObj
     * @returns
     */
    static peek(key: string, cacheObj?: any): any;
    /**
     * 返回所有键集合
     * @param cacheObj
     * @returns
     */
    static keys(cacheObj?: any): Generator<any, void, unknown>;
    /**
     * 清空缓存
     * @param cacheObj
     */
    static clear(cacheObj?: any): void;
}
export default WebCacheTool;