@graphql-ts/schema

中文文档
1.0.2发布于 2025/03/14MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 7.8万

Type-safety for constructing GraphQL schemas in TypeScript

原始使用文档

@graphql-ts/schema

@graphql-ts/schema is a thin wrapper around GraphQL.js providing type-safety for constructing GraphQL Schemas while avoiding type-generation, declaration merging and decorators.

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 共发布 34 个版本,首次发布于 2021/06/08;过去 12 个月发布了 0 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.0.2latest2025/03/141.7 年前
1.0.12025/03/131.7 年前
1.0.02025/03/121.7 年前
0.0.0-test-20250312054156test2025/03/121.7 年前
0.0.0-test-202503120300162025/03/121.7 年前
0.0.0-test-202503112343282025/03/121.7 年前

关于 @graphql-ts/schema 的常见问题

@graphql-ts/schema 是什么?

Type-safety for constructing GraphQL schemas in TypeScript

如何安装 @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 和提交记录判断。