graphql-request

支持 Node 和浏览器的简约 GraphQL 客户端，适用于脚本或简单应用程序。

GitHub Action

亮点
安装
- TypeScript 设置
快速开始
示例
Node 版本支持
参考
- 配置
  - 错误策略
- 忽略操作名称
知识库
项目统计
- 包安装量
- 仓库节拍

亮点

最简单轻量的 GraphQL 客户端
基于 Promise 的 API（可与 async / await 配合使用）
纯 ESM 包
一流的 TypeScript 支持
- 包括 TypedDocumentNode
同构（在 Node 和浏览器中均可使用）

安装

npm add graphql-request graphql

TypeScript 设置

本包使用 package.exports。因此，如果你是 TypeScript 用户，你必须：

将 tsconfig.json 中的 moduleResolution 设置为 "bundler" 或 "node16"/"nodenext"。
将 package.json 中的 type 设置为 "module"。

快速开始

使用静态请求函数发送 GraphQL 文档：

import { gql, request } from 'graphql-request'

const document = gql`
  {
    company {
      ceo
    }
  }
`
await request('https://api.spacex.land/graphql/', document)

可以为该函数传递一个配置对象，以处理更复杂的情况：

await request({
  url,
  document,
  variables,
  requestHeaders,
})

还提供了一个类，用于构建你自己的实例：

import { gql, GraphQLClient } from 'graphql-request'

const document = gql`
  {
    company {
      ceo
    }
  }
`
const endpoint = 'https://api.spacex.land/graphql/'
const client = new GraphQLClient(endpoint)
await client.request(document)

示例

Node 版本支持

我们仅（正式）支持以下状态的 Node.js 版本：

当前版本
长期支持版本
维护版本（且尚未到达生命周期结束）

例如，在 2023 年 10 月 24 日，这意味着支持以下版本：18、20、21。

任何仅存在于不受支持的 Node.js 版本中的问题都将被拒绝（不予处理）。

参考

⚠️ 此参考资料不完整。更多参考资料请查看示例。

配置

ErrorPolicy

默认情况下，当收到错误时，GraphQLClient 将抛出异常。但有时你可能仍想解析收到的（部分）数据。你可以在 GraphQLClient 构造函数中定义 errorPolicy。

const client = new GraphQLClient(endpoint, { errorPolicy: 'all' })

None（默认）

完全不允许错误。如果收到 GraphQL 错误，客户端将抛出异常。

Ignore

忽略收到的错误，解析过程如同没有发生错误一样

All

同时返回错误和数据，仅适用于 rawRequest。

IgnoreOperationName

引入 OperationName 是为了解决这里报告的问题支持操作名称，然而，在某些情况下，请求中可能不需要这些信息。在这种情况下，你可以考虑忽略 operationName，以避免当文档以字符串格式提供时，当前由解析操作执行的提取步骤。

默认情况下，GraphQLClient 会尝试从文档中提取 operationName。你可以在 GraphQLClient 的构造函数中定义 excludeOperationName 以避免在不需要时进行提取过程。如果你不使用 operationName 并希望尽可能优化查询以减少计算量，这可能会很有用，特别是在我们使用字符串格式的文档以减少包大小的情况下。

// 不忽略操作名称的示例
const client = new GraphQLClient(endpoint, {
  method: 'POST',
})
// 忽略操作名称的示例
const client = new GraphQLClient(endpoint, {
  method: 'POST',
  excludeOperationName: true,
})