t-comm
Version:
专业、稳定、纯粹的工具库
44 lines (43 loc) • 1.26 kB
TypeScript
/**
* 写入持久化存储localStorage。仅用于浏览器端，value里不能有循环引用
* @param {string} key 键
* @param {string} value 值
* @param {number} expireMsec 过期时间，单位毫秒
* @returns {boolean} 是否存储成功
*
* @example
* const res = savePersist('name', 'mike', 30 * 86400 * 1000); // true
* const name = getPersist('name'); // mike
*
* clearPersist('name'); // true
* const name2 = getPersist('name'); // undefined
*/
export declare function savePersist(key: string, value: string, expireMsec?: number): boolean;
/**
* 读取持久化存储
* @param {string} key
* @returns {string} key对应的值
* @example
* ```ts
* savePersist('name', 'mike');
* getPersist('name'); // 'mike'
*
* // 已过期或不存在返回 undefined
* getPersist('not-exist'); // undefined
* ```
*/
export declare function getPersist(key: string): any;
/**
* 持久化存储。清理。传 key 就删除。不传清理所有过期的。
* @param {string} [key]
* @returns {boolean} 是否清楚成功
* @example
* ```ts
* // 清理指定 key
* clearPersist('name');
*
* // 不传参数时，清理所有已过期的数据
* clearPersist();
* ```
*/
export declare function clearPersist(key?: string): boolean;