yy-storage
v1.0.0
Published
统一的本地存储管理工具,支持过期时间、版本控制等功能
Maintainers
Readme
yy-storage
统一的本地存储管理工具,支持过期时间、版本控制等功能。
安装
npm install yy-storage使用
基础用法
import storage from 'yy-storage';
// 设置值
storage.set('user', { name: 'John', age: 30 });
// 获取值
const user = storage.get('user');
// { name: 'John', age: 30 }
// 移除值
storage.remove('user');
// 检查是否存在
if (storage.has('user')) {
// ...
}SessionStorage
import { sessionStore } from 'yy-storage';
sessionStore.set('temp', 'value');
const temp = sessionStore.get('temp');带过期时间的存储
import storage from 'yy-storage';
// 设置 30 分钟后过期
storage.setWithExpire('token', 'abc123', 30);
// 30 分钟后自动失效
setTimeout(() => {
const token = storage.get('token'); // null
}, 31 * 60 * 1000);自定义存储实例
import { createStorage } from 'yy-storage';
import logger from 'logger';
// 创建自定义前缀的存储
const myStorage = createStorage('myapp_', localStorage, logger);
myStorage.set('key', 'value');API
StorageManager 类
方法
set(key, value, options)- 设置存储get(key, defaultValue)- 获取存储remove(key)- 移除存储clear()- 清空所有带前缀的存储keys()- 获取所有键名has(key)- 检查键是否存在setWithExpire(key, value, expireMinutes)- 设置带过期时间的存储getSize()- 获取存储大小(KB)
createStorage(prefix, storageType, logger)
创建自定义存储实例。
参数:
prefix(string) - 键名前缀storageType(Storage) - 存储类型,默认localStoragelogger(Logger) - 日志实例(可选)
特性
- ✅ 自动版本控制
- ✅ 过期时间支持
- ✅ 键名前缀隔离
- ✅ 错误处理
- ✅ TypeScript 支持
- ✅ 可配置日志
