@apollo/graphql-testing-library

中文文档
0.3.0发布于 2024/08/30MITTypeScriptESM + CJS构建来源已验证近 30 天下载 20.6万

Apollo GraphQL Logo

图QL 测试i

中文使用文档
文档目录3 节
  1. 安装
  2. 使用量
  3. createHandler

Apollo GraphQL Logo

图QL 测试库

测试鼓励使用 GraphQL 构建的 TypeScript 应用程序的良好做法的公用设备.

npm version badge workflow Join our Discord server


图QL 测试库 提供便于生成的公用事业 模拟服务工人 任意 GraphQL API 的处理器.

MSW就是那个 测试图书馆推荐 如何在测试中公开模拟API的通信 而不刺耳 window.fetch。 。 。 .

此库目前支持递增的传送功能 @defer 财务报告和审定财务报表 @stream 以及WebSockets等其他运输工具, 目前为MSW的β。 。 。 .

这个项目不属于 "试文库" 激励它的生态系统。 我们只是粉丝:)

安装

这个图书馆 peerDependencies 清单 msw 时间 ^2.0.0 财务报告和审定财务报表 graphql 时间 ^15.0.0 || ^16.0.0。使用您首选的软件包管理器与此库一起安装 :

npm install --save-dev @apollo/graphql-testing-library msw graphql
pnpm add --save-dev @apollo/graphql-testing-library msw graphql
yarn add --dev @apollo/graphql-testing-library msw graphql
bun add --dev @apollo/graphql-testing-library msw graphql

使用量

createHandler

import { createHandler } from "@apollo/graphql-testing-library";

// We suggest using @graphql-tools/mock and @graphql-tools/schema
// to create a schema with mock resolvers.
// See https://the-guild.dev/graphql/tools/docs/mocking for more info.
import { addMocksToSchema } from "@graphql-tools/mock";
import { makeExecutableSchema } from "@graphql-tools/schema";
import typeDefs from "./schema.graphql";

// Create an executable schema
const schema = makeExecutableSchema({ typeDefs });

// Add mock resolvers
const schemaWithMocks = addMocksToSchema({
  schema,
  resolvers: {
    Query: {
      products: () =>
        Array.from({ length: 5 }, (_element, id) => ({
          id: `product-${id}`,
        })),
    },
  },
});

// `createHandler` returns an object with a `handler` and `replaceSchema`
// function: `handler` is a MSW handler that will intercept all GraphQL
// operations, and `replaceSchema` allows you to replace the mock schema
// the `handler` use to resolve requests against.
const { handler, replaceSchema } = createHandler(schemaWithMocks, {
  // It accepts a config object as the second argument where you can specify a
  // delay duration, which uses MSW's delay API:
  // https://mswjs.io/docs/api/delay
  // Default: "real" (100-400ms in browsers, 20ms in Node-like processes)
  delay: number | "infinite" | "real",
});

版本与发布记录

@apollo/graphql-testing-library 共发布 11 个版本,首次发布于 2024/06/15;过去 12 个月发布了 0 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.3.0latest2024/08/302 年前
0.0.0-pr-93-20240814151011pr2024/08/142 年前
0.0.0-pr-83-202408132042142024/08/142 年前
0.0.0-pr-83-202408051911022024/08/062 年前
0.0.0-pr-83-202408012129132024/08/022 年前
0.0.0-pr-73-202407242033482024/07/252 年前

关于 @apollo/graphql-testing-library 的常见问题

@apollo/graphql-testing-library 是什么?

图QL 测试i

如何安装 @apollo/graphql-testing-library?

在项目目录运行 npm install @apollo/graphql-testing-library,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:msw(^2.0.0)、graphql(^15.0.0 || ^16.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@apollo/graphql-testing-library 支持 TypeScript 吗?

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

@apollo/graphql-testing-library 支持 ESM 还是 CommonJS?

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

@apollo/graphql-testing-library 可以商用吗?

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

@apollo/graphql-testing-library 的下载量有多少?

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

@apollo/graphql-testing-library 还在维护吗?

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