# @graphql-ts/schema 中文文档

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

版本：1\.0\.2
npm 元数据更新时间：2026-02-25T01:25:14.913Z
中文译文更新时间：2026-11-16T23:12:40.913Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：129 kB，18 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：graphql 16
- 首次发布：2021-06-08T01:06:18.874Z
- 最新版本发布：2025-03-14T00:33:29.792Z
- 近 30 天下载量：78384（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：34（近 12 个月 0 个）

## 中文简介

用于构建 TypeScript 中的 GraphQL 方案的类型安全

## 安装

```sh
npm install @graphql-ts/schema
```

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

## README

# @ graphql-ts/ schema (英语)

`@graphql-ts/schema` 是薄薄的包装 [图QL.js](https://github.com/graphql/graphql-js) 提供类型安全 在避免类型生成的同时构建 GraphQL Schemas, [声明合并](https://www.typescriptlang.org/docs/handbook/declaration-merging.html) 财务报告和审定财务报表 [装饰器](https://www.typescriptlang.org/docs/handbook/decorators.html)。 。 。 .

```ts
import { gWithContext } from "@graphql-ts/schema";
import { GraphQLSchema, graphql } from "graphql";

type Context = {
  loadPerson: (id: string) => Person | undefined;
  loadFriends: (id: string) => Person[];
};
const g = gWithContext<Context>();
type g<T> = gWithContext.infer<T>;

type Person = {
  id: string;
  name: string;
};

const Person: g<typeof g.object<Person>> = g.object<Person>()({
  name: "Person",
  fields: () => ({
    id: g.field({ type: g.nonNull(g.ID) }),
    name: g.field({ type: g.nonNull(g.String) }),
    friends: g.field({
      type: g.list(g.nonNull(Person)),
      resolve(source, _, context) {
        return context.loadFriends(source.id);
      },
    }),
  }),
});

const Query = g.object()({
  name: "Query",
  fields: {
    person: g.field({
      type: Person,
      args: {
        id: g.arg({ type: g.nonNull(g.ID) }),
      },
      resolve(_, args, context) {
        return context.loadPerson(args.id);
      },
    }),
  },
});

const schema = new GraphQLSchema({
  query: Query,
});

{
  const people = new Map<string, Person>([
    ["1", { id: "1", name: "Alice" }],
    ["2", { id: "2", name: "Bob" }],
  ]);
  const friends = new Map<string, string[]>([
    ["1", ["2"]],
    ["2", ["1"]],
  ]);
  const contextValue: Context = {
    loadPerson: (id) => people.get(id),
    loadFriends: (id) => {
      return (friends.get(id) ?? [])
        .map((id) => people.get(id))
        .filter((person) => person !== undefined) as Person[];
    },
  };
  graphql({
    source: `
      query {
        person(id: "1") {
          id
          name
          friends {
            id
            name
          }
        }
      }
    `,
    schema,
    contextValue,
  }).then((result) => {
    console.log(result);
  });
}
```

## 常见问题

### @graphql-ts/schema 是什么？

用于构建 TypeScript 中的 GraphQL 方案的类型安全

### 如何安装 @graphql-ts/schema？

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

### @graphql-ts/schema 支持 TypeScript 吗？

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

### @graphql-ts/schema 支持 ESM 还是 CommonJS？

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

### @graphql-ts/schema 可以商用吗？

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

### @graphql-ts/schema 的下载量有多少？

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

### @graphql-ts/schema 还在维护吗？

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

