# @graphql-tools/documents 中文文档

规范地址：https://npmcn.com/package/%40graphql-tools/documents/

版本：2\.0\.0
npm 元数据更新时间：2026-10-19T14:44:30.977Z
中文译文更新时间：2026-11-16T23:10:43.978Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40graphql-tools/documents
原文对照：https://npmcn.com/package/%40graphql-tools/documents/?lang=original
项目主页：https://github.com/ardatan/graphql-tools#readme
源码仓库：https://github.com/ardatan/graphql-tools

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

- 包体积（解压后）：20.7 kB，23 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18\.0
- 运行依赖：1 个
- peer 依赖：graphql ^16\.0\.0 \|\| ^17\.0\.0
- 首次发布：2023-01-09T07:01:08.405Z
- 最新版本发布：2026-10-19T14:44:30.616Z
- 近 30 天下载量：32524228（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：167（近 12 个月 139 个）

## 中文简介

GraphQL 文件的公用事业.

## 安装

```sh
npm install @graphql-tools/documents
```

也可以使用：`pnpm add @graphql-tools/documents`、`yarn add @graphql-tools/documents`、`bun add @graphql-tools/documents`

## README

# `@graphql-tools/documents`

GraphQL 文件的公用事业.

## 安装

```bash
npm install @graphql-tools/documents
```

## 目录

### 打印图表QL 文档

打印 GraphQL 文档的稳定方式。 所有可执行/分解的可变定义,字段为 以稳定的方式打印。 对像持续GraphQL操作之类的东西有用.

#### 使用量

```ts
import { parse } from 'graphql'
import { printExecutableGraphQLDocument } from '@graphql-tools/documents'

const inputDocument = parse(/* GraphQL */ `
  query A {
    ... on Query {
      a {
        ...B
        b
      }
    }
    ... on Query {
      a {
        ...B
        a
      }
    }
  }

  fragment B on Query {
    c
  }
`)
const outputStr = printExecutableGraphQLDocument(inputDocument)
console.assert(
  outputStr ===
    'fragment B on Query { c } query A { ... on Query { a { a ...B } } ... on Query { a { b ...B } } }',
  'Stuff is not equal.'
)
```

#### 规则

-   碎片总是在可执行操作前打印
-   可执行操作按名称以字母排序 .
-   参数(指令、字段)按字母顺序排序
-   选择集被排序为字段, FlagmentSpread, InlineFragmentSpread(基于 类型条件, 内置选择集)

## 常见问题

### @graphql-tools/documents 是什么？

GraphQL 文件的公用事业\.

### 如何安装 @graphql-tools/documents？

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

### @graphql-tools/documents 支持 TypeScript 吗？

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

### @graphql-tools/documents 支持 ESM 还是 CommonJS？

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

### @graphql-tools/documents 需要什么版本的 Node\.js？

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

### @graphql-tools/documents 可以商用吗？

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

### @graphql-tools/documents 的下载量有多少？

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

### @graphql-tools/documents 还在维护吗？

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

