# @apeira/storage 中文文档

规范地址：https://npmcn.com/package/%40apeira/storage/

版本：0\.0\.8
npm 元数据更新时间：2026-08-08T16:01:46.237Z
中文译文更新时间：2026-11-06T09:01:12.358Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40apeira/storage
原文对照：https://npmcn.com/package/%40apeira/storage/?lang=original
项目主页：https://github.com/moeru-ai/apeira
源码仓库：https://github.com/moeru-ai/apeira

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

- 包体积（解压后）：15 kB，14 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@apeira/core 0\.0\.8
- 首次发布：2026-06-19T11:33:27.954Z
- 最新版本发布：2026-08-08T16:01:45.878Z
- 近 30 天下载量：93409（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

用于Apeira剂的持久性存储适配器.

## 安装

```sh
npm install @apeira/storage
```

也可以使用：`pnpm add @apeira/storage`、`yarn add @apeira/storage`、`bun add @apeira/storage`

## README

# @apeira/仓库

持久性 `AgentStorage` 关于阿皮拉的执行.

## 安装

```sh
pnpm add @apeira/storage
```

## 贾森

将完整的条目数组存储在 JSON 文件。 每个附件重写文件.

```ts
import { createAgent } from '@apeira/core'
import { json } from '@apeira/storage/json'

const agent = createAgent({
  instructions: 'You are a helpful assistant.',
  runner,
  storage: json({ path: './data/agent.json' }),
})
```

当人可读文件有用且历史为时使用 JSON 存储 相对小.

## 贾森勒

每行存储一个条目并附加新条目而不重写现有条目 内容.

```ts
import { createAgent } from '@apeira/core'
import { jsonl } from '@apeira/storage/jsonl'

const agent = createAgent({
  instructions: 'You are a helpful assistant.',
  runner,
  storage: jsonl({ path: './data/agent.jsonl' }),
})
```

JSONL是长期运行,附件重的代理更好的文件格式.

## 密钥值存储

适应网络存储或同步等字符串键值后端 存储 API. 条目被分割成块来避免存储完整日志 在一个钥匙下.

```ts
import type { StorageLike } from '@apeira/storage/kv'

import { createAgent } from '@apeira/core'
import { kv } from '@apeira/storage/kv'

declare const backend: StorageLike

const agent = createAgent({
  instructions: 'You are a helpful assistant.',
  runner,
  storage: kv({
    backend,
    prefix: 'assistant',
    segmentSize: 100,
  }),
})
```

后端必须执行:

```ts
import type { MaybePromise } from '@apeira/core'

interface StorageLike {
  getItem: (key: string) => MaybePromise<null | string | undefined>
  removeItem: (key: string) => MaybePromise<void>
  setItem: (key: string, value: string) => MaybePromise<void>
}
```

`prefix` 默认为 `apeira` 财务报告和审定财务报表 `segmentSize` 默认为 `100`。 。 。 .

## 储存寿命周期

所有实施都提供标准 `AgentStorage` 操作 :

```ts
import type { MaybePromise } from '@apeira/core'

interface AgentStorage<T> {
  append: (...items: T[]) => MaybePromise<void>
  clear: () => MaybePromise<void>
  read: () => MaybePromise<Readonly<T[]>>
}
```

仅管理持续存在的条目 。 代理初始化和重置 基准属于核心:

```ts
const agent = createAgent({
  initialInput: [user('Existing context')],
  initialState: { userId: 'user-123' },
  instructions: 'You are a helpful assistant.',
  runner,
  storage: jsonl({ path: './data/agent.jsonl' }),
})
```

在初始化期间,核心写 `initialInput` 仅当存储包含无 输入条目. `agent.reset()` 清除存储并恢复 `initialInput` 财务报告和审定财务报表 `initialState`。 。 。 .

## 一般存储

存储函数默认为 `AgentEntry`但可以存储另一个 JSON 序列大小类型 :

```ts
const store = jsonl<string>({ path: './data/items.jsonl' })

await store.append('first', 'second')
const items = await store.read()
```

JSON和JSONL的存储需要节点.js. 任何运行时间的密钥值存储工作 提供了兼容的后端.

## 常见问题

### @apeira/storage 是什么？

用于Apeira剂的持久性存储适配器\.

### 如何安装 @apeira/storage？

在项目目录运行 npm install @apeira/storage，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@apeira/core（0\.0\.8）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @apeira/storage 支持 TypeScript 吗？

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

### @apeira/storage 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @apeira/storage 可以商用吗？

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

### @apeira/storage 的下载量有多少？

根据 npm 官方下载统计，@apeira/storage 在 2026/10/06 – 2026/11/04 这 30 天内被下载 93,409 次，日均约 3,114 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @apeira/storage 还在维护吗？

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