@likg/storage/dist/types/index.d.ts

Storage APIs

declare class Storage {
    /**
     * 存储数据
     * @param key 键
     * @param value 值
     */
    static set(key: string, value: any): void;
    /**
     * 读取数据
     * @param key 键
     * @returns
     */
    static get<T = any>(key: string): T | void;
    /**
     * 移除数据
     * key的类型可以为字符串、字符串数组以及undefined
     * 根据不同类型，有如下三种结果：
     * - 当key为字符串时/移除指定key对应的数据
     * - 当key为字符串数组时/遍历删除指定key对应的数据
     * - 当key为undefined时/清空所有本地数据
     * @param key
     */
    static del(key?: string | string[]): void;
    /**
     * 查找元素
     * @param key
     * @param indexes
     * @param value
     * @returns
     */
    static arrFind<T = any>(key: string, indexes: keyof T, value: any): T | undefined;
    /**
     * 列表存储
     * @param key
     * @param obj
     */
    static arrSave<T = any>(key: string, obj: T, indexes?: keyof T): Promise<unknown>;
    /**
     * 获取列表
     * @param key
     * @returns
     */
    static arrGet<T = any>(key: string): T[];
    /**
     * 移除列表数据
     * 如果indexes和value没有传递，则表示清空列表
     * 如果要移除字段，请调用Storage.del(key: string)
     * @param key 存储键
     * @param indexes 索引
     * @param value 索引值
     * @returns
     */
    static arrDel<T = any>(key: string, indexes?: keyof T, value?: any): void;
}
export default Storage;