@fallen-zero/use/dist/useStore/index.d.ts

fallen-zero Api

export declare enum StorageEnum {
    LOCAL = "localStorage",
    SESSION = "sessionStorage",
    COOKIE = "cookie"
}
export interface IDate {
    data: any;
    expire?: number;
}
export interface IStorage {
    expire?: number;
    storage?: StorageEnum;
}
export declare const useStore: (prefix?: string) => {
    /** 设置存储中的键值对。
     * @param {string} key - 要设置值的键。
     * @param {T} data - 要存储的数据。
     * @param {IStorage} [options] - 可选的存储配置。
     *        - expire: 过期时间（秒）若是cookie类型的存储，单位是(天)，过期时间默认为7天。
     *        - storage: 存储类型（默认为 StorageEnum.SESSION）。
     * @return {void}
     */
    set<T = any>(key: string, data: T, { expire, storage }?: IStorage): void;
    /** 从指定的存储中检索与指定键相关联的值。
     * @param {string} key - 用于检索值的键。
     * @param {StorageEnum} [storage=StorageEnum.SESSION] - 要从中检索值的存储类型。默认为 `StorageEnum.SESSION`。
     * @return {T | null} - 检索到的值，如果键不存在或值已过期，则返回 `null`。
     */
    get<T_1 = any>(key: string, storage?: StorageEnum): T_1 | null;
    /** 从指定的存储中删除一个键。
     * @param {string} key - 要删除的键。
     * @param {StorageEnum} [storage=StorageEnum.SESSION] - 要从中删除键的存储。默认为 StorageEnum.SESSION。
     */
    remove(key: string, storage?: StorageEnum): void;
};