@umworks/taro-use-storage

一个用于 Taro 小程序的存储管理工具，提供便捷的缓存操作、过期控制和加密等功能。

特性

• 支持数据前缀，方便区分不同模块
• 支持数据过期时间设置
• 提供简单的数据加密功能
• TypeScript 支持，提供完整类型定义

安装

npm install @umworks/taro-use-storage --save
# 或使用 yarn
yarn add @umworks/taro-use-storage

使用方法

基础使用

import { useStorage } from '@umworks/taro-use-storage';

// 创建存储实例
const storage = useStorage();

// 设置数据
storage.set('user', { id: 1, name: '张三' });

// 获取数据
const user = storage.get('user');
console.log(user); // { id: 1, name: '张三' }

// 设置带过期时间的数据（1小时后过期）
storage.set('token', 'abc123', 60 * 60 * 1000);

// 删除数据
storage.remove('user');

// 清空所有数据
storage.clear();

配置选项

import { useStorage } from '@umworks/taro-use-storage';

// 使用自定义配置
const storage = useStorage({
  // 存储前缀
  prefix: 'my_app_',
  // 是否启用加密
  encrypt: true,
  // 加密密钥
  secretKey: 'my_secret_key'
});

// 使用自定义前缀存储数据
storage.set('settings', { theme: 'dark' });
// 实际存储的键为 "my_app_settings"

获取所有数据

import { useStorage } from '@umworks/taro-use-storage';

const storage = useStorage();

// 设置多个数据
storage.set('user', { name: '张三' });
storage.set('token', 'abc123');

// 获取所有数据
const allData = storage.getAll();
console.log(allData);
// 输出: { user: { name: '张三' }, token: 'abc123' }

API 文档

useStorage(options?)

创建一个存储实例。

参数:

• options (可选): 配置选项对象
  • prefix: 存储键前缀，默认为 "taro_storage_"
  • encrypt: 是否启用加密，默认为 false
  • secretKey: 加密密钥，默认为 "taro_default_key"

返回: TaroStorage 实例

实例方法

set(key, value, expire?)

设置存储数据。

参数:

• key: 存储键名
• value: 存储的值，可以是任意类型
• expire (可选): 过期时间，毫秒数，不设置则永久有效

get(key, defaultValue?)

获取存储数据。

参数:

• key: 存储键名
• defaultValue (可选): 默认值，当获取失败或已过期时返回

返回: 存储的值或默认值

remove(key)

移除存储数据。

参数:

• key: 存储键名

clear()

清除所有带前缀的存储数据。

getAll()

获取所有存储的数据。

返回: 包含所有数据的对象

许可证

MIT