@shencom/utils-localforage

对 localForage 的二次封装

Install

pnpm add @shencom/utils

# or

pnpm add @shencom/utils-localforage

Basic Usage

import { ScLocalForage } from '@shencom/utils';
// import { ScLocalForage } from '@shencom/utils-localforage';

const localForage = new ScLocalForage(ScLocalForageOption);

Option

interface ScLocalForageOption extends Partial<LocalForageOptions> {
  scid: string;
  prefix?: string;
}

| 参数 | 说明 | 类型 | 可选值 | 默认值 | | ------ | -------------- | ------ | ------ | ------ | | scid | 前缀唯一标识符 | String | - | - | | prefix | 自定义前缀 | String | - | - |

Methods

get

• 说明: 获取存储数据
• 类型: get<T = any>(key: string): T | null
• 示例:

  const data = await localForage.get(key);

set

• 说明: 设置存储数据
• 类型: set(key: string, data: any, time?: number): void
• 参数:
  • key: 存储的 key
  • data: 存储的值
  • time: 存储时间(单位为分钟)，默认: 永久
• 示例:

  await localForage.set(key, data, 10); // 10分钟
  await localForage.set(key, data); // 永久

remove

• 说明: 移除指定存储数据
• 类型: remove(key: string): void
• 参数:
  • key: 存储的 key
• 示例:

  await localForage.remove(key);

clear

• 说明: 清空存储数据
• 类型: clear(isAll?: boolean): void
• 示例:

  await localForage.clear(); // 全部清除

keys

• 说明: 获取存储所有的 key
• 类型: keys(): string[]
• 示例:

  const keys = await localForage.keys();