# @gql2ts/from-query 中文文档

规范地址：https://npmcn.com/package/%40gql2ts/from-query/

版本：2\.0\.0-4
npm 元数据更新时间：2022-06-12T19:22:04.924Z
中文译文更新时间：2026-11-16T21:19:17.890Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：71.9 kB，17 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：graphql \>= 0\.10 \<15
- 首次发布：2017-03-27T17:16:39.505Z
- 最新版本发布：2020-03-13T22:24:06.251Z
- 近 30 天下载量：13635（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：69（近 12 个月 0 个）

## 中文简介

从图表ql 计划和查询中生成打字符界面

## 安装

```sh
npm install @gql2ts/from-query
```

也可以使用：`pnpm add @gql2ts/from-query`、`yarn add @gql2ts/from-query`、`bun add @gql2ts/from-query`

## README

# @gql2ts/ from-query (英语)

此软件包用于从 GraphQL Schema 和一个查询中生成类型/界面 .

## 目标

通过图表QL `type` 生成 TypeScript 界面的计划 :

输入 :

```graphql
type Query {
  thing: String!
  anotherThing: Boolean!
}
```

输出 :

```ts
interface IQuery {
  thing: string;
  anotherThing: boolean;
}
```

## 基本用途

```ts
import fromQuery from '@gql2ts/from-query';
import { schema, query } from 'my-graphql-stuff';
import * as fs from 'fs';

const typescriptDefinitions = fromQuery(schema, query);

const allDefinitions = typescriptDefinitions.map(({ result }) => result).join('\n');

fs.writeFile('definition.d.ts', allDefinitions);
```

## 高级使用

```ts
import fromQuery from '@gql2ts/from-query';
import { schema, query } from 'my-graphql-stuff';
// see `IOptions` in `types.ts` for options
import * as options from './customFormatters';
import * as fs from 'fs';

const myCustomTypes = {
  Date: 'string',
  Map: 'object',
}

const typescriptDefinitions = fromQuery(schema, query, myCustomTypes, options);

const allDefinitions = typescriptDefinitions.map(({ result }) => result).join('\n');

fs.writeFile('definition.d.ts', allDefinitions);
```

## 常见问题

### @gql2ts/from-query 是什么？

从图表ql 计划和查询中生成打字符界面

### 如何安装 @gql2ts/from-query？

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

### @gql2ts/from-query 支持 TypeScript 吗？

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

### @gql2ts/from-query 支持 ESM 还是 CommonJS？

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

### @gql2ts/from-query 可以商用吗？

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

### @gql2ts/from-query 的下载量有多少？

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

### @gql2ts/from-query 还在维护吗？

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

