@codesandbox/create-gql-api

中文文档
1.0.1发布于 2025/01/25ISCTypeScriptESM + CJS近 30 天下载 2.2万

简化GQL打字和消费

中文使用文档

创建- gql- api

简化GQL打字和消费

开始

npx create-gql-api https://example.domain/graphql gql_api.ts

这会产生一个 gql_api.ts 文档.

import {
  createRequester,
  createSubscriber,
  createQuery,
  createMutation,
  createSubscription,
} from "./gql_api.ts";

const query = createRequester((query, variables) => {
  // Implement the GraphQL POST request with the
  // query, variables and any authentication you use
  // for your app
  return new Promise(() => {});
});

const subscribe = createSubscriber((query, variables, onMessage) => {
  // Optionally implement subscription handling
  // Call "onMessage" with new data
  // Return a disposer
  return () => {};
});

// Create a query by giving it a name and what fields to include
export const queryFoo = createQuery("Foo", {
  foo: {
    name: true,
    email: true,
  },
});
query(queryFoo);

// Query on simple values
export const queryBar = api.createQuery("Bar", {
  bar: [{ unit: "FOOTER" }],
});
query(queryBar);

// Query on object and lists
export const queryBaz = api.createQuery("Baz", {
  baz: [
    { id: "123" },
    {
      id: true,
    },
  ],
});
query(queryBaz);

// Query with variables
export const queryBazWithVars = createQuery(
  "BazWithVars",
  (vars: { id: string }) => ({
    baz: [
      { id: vars.id },
      {
        id: true,
      },
    ],
  }),
);
query(queryBazWithVars, { id: "123" });

// Mutations works like queries
export const mutateSomething = createMutation("Something", () => ({
  something: [{}],
}));
query(mutateSomething);

// Subscriptions
export const subscribeSomething = createSubscription(
  "Something",
  (vars: { id: string }) => ({
    something: [{ id: vars.id }],
  }),
);
subscribe(
  subscribeSomething,
  (data) => {
    // Handle the data
  },
  { id: "123" },
); // Returns disposer

版本与发布记录

@codesandbox/create-gql-api 共发布 2 个版本,首次发布于 2024/12/12;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.1latest2025/01/251.8 年前
0.1.02024/12/121.9 年前

关于 @codesandbox/create-gql-api 的常见问题

@codesandbox/create-gql-api 是什么?

简化GQL打字和消费

如何安装 @codesandbox/create-gql-api?

在项目目录运行 npm install @codesandbox/create-gql-api,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 create-gql-api,可以用 npx create-gql-api 直接运行。

@codesandbox/create-gql-api 支持 TypeScript 吗?

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

@codesandbox/create-gql-api 支持 ESM 还是 CommonJS?

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

@codesandbox/create-gql-api 可以商用吗?

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

@codesandbox/create-gql-api 的下载量有多少?

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

@codesandbox/create-gql-api 还在维护吗?

最新版本 1.0.1 发布于 2025/01/25(1.8 年前);至今共发布 2 个版本,其中过去 12 个月发布了 0 个;首次发布于 2024/12/12。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。