# @cacheplane/json-stream 中文文档

规范地址：https://npmcn.com/package/%40cacheplane/json-stream/

版本：0\.1\.1
npm 元数据更新时间：2026-10-01T05:00:26.301Z
中文译文更新时间：2026-11-08T23:02:30.883Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cacheplane/json-stream
原文对照：https://npmcn.com/package/%40cacheplane/json-stream/?lang=original
项目主页：https://github.com/cacheplane/cacheplane/tree/main/packages/json-stream#readme
源码仓库：https://github.com/cacheplane/cacheplane

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

- 包体积（解压后）：200 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-05-03T15:11:32.635Z
- 最新版本发布：2026-10-01T05:00:26.010Z
- 近 30 天下载量：11567（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

将递增的 JSON 解析器与 push/pull API,节点后卫,和 JSON 指针解析.

## 安装

```sh
npm install @cacheplane/json-stream
```

也可以使用：`pnpm add @cacheplane/json-stream`、`yarn add @cacheplane/json-stream`、`bun add @cacheplane/json-stream`

## README

# @cacheplane/json-流

递增的 JSON 分析一次到达一个块的输入 .

当AI模型、网络流、工人或工具调用JSON时使用它 渐渐地. `JSON.parse()` 需要一个完整的文档; 此解析器会给您一个 文档到达时键入树, 标记每个节点 `partial` 或者说 `complete` 这样你就能把落地的东西 留下剩下的东西.

## 安装

```bash
npm install @cacheplane/json-stream
```

运行时间和包装 :

-   节点 `>=20`
-   包含类型脚本声明
-   无害环境管理和CJS捆绑在一起
-   零运行时间依赖关系
-   标出无副作用

## 30- 第二实例

```ts
import { create, push, finish, isObjectNode } from "@cacheplane/json-stream";

let state = create();

for (const chunk of ['{"name": "Ada', '", "age": 3', "6}"]) {
  state = push(state, chunk);
}

state = finish(state);

if (isObjectNode(state.root)) {
  // Every node carries a status, so a half-arrived string is still readable.
  console.log(state.root.status); // "complete"
}
```

## 心理模式

3个函数驱动整个解析器, 每个函数返回一个新的 `StreamState` 而不是改变你通过的那个:

-   `create()` - 一个新鲜而空的状态.
-   `push(state, chunk)` ——喂下个块;安全到任何字节边界, 包括中键和中键逃逸顺序.
-   `finish(state)` ——输入信号端. 任何尚未解决的问题都会解决 报告为 `StreamError`。 。 。 .

树上的每个节点都带有 `status` 联 合 国 `partial` 或者说 `complete`这是 整个库的区别: 消费者可以制造字符串 并且知道不要把它当作最终决定.

## 结构错误

已解析对象值保留 JSON 密钥为可自控、可写入、, 普通对象上的可配置数据属性,包括空键和 诸如 `__proto__`, (中文(简体) ), `constructor`,以及 `toString`复制密钥 最后一个值,匹配 `JSON.parse`定义 JSON 密钥并不改变 结果对象的原型.

当分析失败时, `state.error` 包含一个 `StreamError` 与源位置, 人能读取 `message`和马厩 `code` b. 从公众那里 `StreamErrorCode` 工会:

```ts
type StreamErrorCode =
  | "INVALID_SYNTAX"
  | "UNEXPECTED_END"
  | "TRAILING_CONTENT";
```

-   `INVALID_SYNTAX` 表示一个符号或JSON语法规则有误,包括: 无法解析的已完成原始 .
-   `UNEXPECTED_END` 表示 `finish()` 找到在值或值时结束的输入 容器仍然是一个渐进有效的前缀。 包括号码 前缀,例如 `-`, (中文(简体) ), `1.`,以及 `1e+`,可以在更多情况下生效 输入.
-   `TRAILING_CONTENT` 表示在根 JSON 后到达的更多非空白输入 数值已经完成.

使用 `code` 用于控制流动。 信息仍然对人们和诊断有帮助, 但它们的确切措词不是控制流动合同的一部分。 错误状态 是终端: 稍后 `push()` 财务报告和审定财务报表 `finish()` 调用保留相同的结构 错误状态 .

## 类型警卫

缩小每个节点类型的帮助, 外加状态检查 :

```ts
import {
  isArrayNode,
  isBoolNode,
  isComplete,
  isNullNode,
  isNumberNode,
  isObjectNode,
  isStringNode,
} from "@cacheplane/json-stream";
```

`isComplete(node)` 当决定一个值是否为 安全下游承诺.

## JSON 指针查询

`resolve` 从树上读出一个节点 [RFC 6901 (英语)](https://datatracker.ietf.org/doc/html/rfc6901) 指针,即 当您关心大流文件的一个字段时, 方便:

```ts
import { resolve } from "@cacheplane/json-stream";

const node = resolve(state.root, "/choices/0/message/content");
```

它回来了 `undefined` 当路径尚不存在时——一个正常条件 中流,不是错.

## 相关

-   [`@cacheplane/partial-json`](https://npmcn.com/package/%40cacheplane/partial-json) 更丰富的部分JSON解析器 与保存身份和结构共享相结合.
-   [`@cacheplane/partial-markdown`](https://npmcn.com/package/%40cacheplane/partial-markdown) - 同样的想法 流出马克下.

## 许可证

麻省理工学院

## 常见问题

### @cacheplane/json-stream 是什么？

将递增的 JSON 解析器与 push/pull API,节点后卫,和 JSON 指针解析\.

### 如何安装 @cacheplane/json-stream？

在项目目录运行 npm install @cacheplane/json-stream，或使用 pnpm add / yarn add / bun add。

### @cacheplane/json-stream 支持 TypeScript 吗？

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

### @cacheplane/json-stream 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @cacheplane/json-stream 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cacheplane/json-stream 可以商用吗？

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

### @cacheplane/json-stream 的下载量有多少？

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

### @cacheplane/json-stream 还在维护吗？

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