rc-hooks
Version:
React Hooks Library.
25 lines (24 loc) • 1.01 kB
TypeScript
import { TStorage } from 'cache2';
/**
* 清理 `useCacheState` 缓存。如果不传 `key`,表示清理全部。
*
* @see {@link https://github.com/caijf/cache2 | cache2}
* @param storage 自定义数据存储器,支持 `localStorage` `sessionStorage`。默认使用内存缓存。
* @param key 键名称。
*/
export declare function clearCacheState(storage?: TStorage, key?: string | string[]): void;
/**
* 缓存状态。
*
* @param key 键名称。
* @param defaultValue 默认值。
* @param options 选项。
* @param options.ttl 过期时间,单位毫秒。默认不过期。
* @param options.storage 自定义数据存储器,支持 `localStorage` `sessionStorage`。默认使用内存缓存。
* @returns 状态值和更新状态值的函数。
*/
declare function useCacheState<T>(key: string, defaultValue?: T, options?: {
ttl?: number;
storage?: TStorage;
}): readonly [T, import("react").Dispatch<import("react").SetStateAction<T>>];
export default useCacheState;