# @aveq-research/localforage-asyncstorage-driver 中文文档

规范地址：https://npmcn.com/package/%40aveq-research/localforage-asyncstorage-driver/

版本：3\.0\.1
npm 元数据更新时间：2022-04-04T16:46:02.699Z
中文译文更新时间：2026-11-07T07:55:15.298Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40aveq-research/localforage-asyncstorage-driver
原文对照：https://npmcn.com/package/%40aveq-research/localforage-asyncstorage-driver/?lang=original
项目主页：https://github.com/aveq-research/localforage-asyncstorage-driver#readme
源码仓库：https://github.com/aveq-research/localforage-asyncstorage-driver

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：20.7 kB，9 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@react-native-async-storage/async-storage \*，localforage \*，react \*，react-native \*
- 首次发布：2020-05-05T10:30:46.419Z
- 最新版本发布：2020-12-31T15:00:49.745Z
- 近 30 天下载量：6848（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 0 个）

## 中文简介

[![npm version](https://badge.fury.io/js/%40aveq-research%2Flocalforage-asyncstorage-driver.svg)](https://badge.fury.io/js/%40aveq-research%2Flocalforage-asyncstorage-driver)

## 安装

```sh
npm install @aveq-research/localforage-asyncstorage-driver
```

也可以使用：`pnpm add @aveq-research/localforage-asyncstorage-driver`、`yarn add @aveq-research/localforage-asyncstorage-driver`、`bun add @aveq-research/localforage-asyncstorage-driver`

## README

# 本地饲料合成驱动器

[![npm version](https://badge.fury.io/js/%40aveq-research%2Flocalforage-asyncstorage-driver.svg)](https://badge.fury.io/js/%40aveq-research%2Flocalforage-asyncstorage-driver)

此库包含一个驱动程序, 可以使用 [本地饲料](https://github.com/localForage/localForage) 用于反应- Native 的 [同步组合](https://github.com/react-native-community/async-storage)。 。 。 .

## 同伴依赖关系

请注意! 换到v3.0.0 `@react-native-async-storage/async-storage` 成为同伴的依赖!

## 设置

只需通过国家预防机制安装驱动程序:

`npm i --save @aveq-research/localforage-asyncstorage-driver`

如果尚未这样做,确保拥有适当的同伴依赖关系(`react` 再来一次. `react-native`有待安装.

## 使用量

它提供三种不同的方法来创建适当的驱动程序:

-   `driverWithoutSerialization()`: 创建通用的 AsyncStorage 驱动程序, 它不会自动序列化任何数据; 您需要整合自己的序列化 !
-   `driverWithSerialization(serializer)`: 用给定的序列器创建 AsyncStorage 驱动程序; 有效的序列器需要包含一个 `serialize` 财务报告和审定财务报表 `deserialize` 方法
-   `driverWithDefaultSerialization()`: 将使用本地文件的默认序列化

工作代码示例:

```js
import { driverWithoutSerialization } from '@aveq-research/localforage-asyncstorage-driver';

const driver = driverWithoutSerialization();
await localforage.defineDriver(driver);
await localforage.setDriver(driver._driver); // i.e. "rnAsyncStorageWrapper"
```

或者用实例:

```js
import { driverWithoutSerialization } from '@aveq-research/localforage-asyncstorage-driver';

const driver = driverWithoutSerialization();
const instance = localforage.createInstance({ driver });
```

之后你可以使用你已经知道的地方饲料。 关于当地饲料API的进一步问题,请查看 [https://github.com/localForage/localForage 页面存档备份,存于互联网档案馆](https://github.com/localForage/localForage)

## 许可证

此驱动程序分布于以下 麻省理工学院许可证(见 [自由主义](https://github.com/aveq-research/localforage-asyncstorage-driver/blob/master/LICENSE)由伟大的人维护 [简历](https://aveq.info/) 团队.

## 常见问题

### 如何安装 @aveq-research/localforage-asyncstorage-driver？

在项目目录运行 npm install @aveq-research/localforage-asyncstorage-driver，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@react-native-async-storage/async-storage（\*）、localforage（\*）、react（\*）、react-native（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @aveq-research/localforage-asyncstorage-driver 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @aveq-research/localforage-asyncstorage-driver 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @aveq-research/localforage-asyncstorage-driver 可以商用吗？

@aveq-research/localforage-asyncstorage-driver 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @aveq-research/localforage-asyncstorage-driver 的下载量有多少？

根据 npm 官方下载统计，@aveq-research/localforage-asyncstorage-driver 在 2026/10/07 – 2026/11/05 这 30 天内被下载 6,848 次，日均约 228 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @aveq-research/localforage-asyncstorage-driver 还在维护吗？

最新版本 3\.0\.1 发布于 2020/12/31（5 年前）；至今共发布 12 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/05/05。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。