graphql-request

graphql-request

简洁高效的GraphQL客户端 支持Node和浏览器

graphql-request是一个轻量级GraphQL客户端,适用于Node和浏览器环境。它提供基于Promise的API和TypeScript支持,是纯ESM包。这个客户端适合小型脚本和简单应用,不含缓存和前端框架集成,保持最小化的包大小和API。支持异步/await语法,并提供错误策略和自定义JSON序列化等配置选项。

GraphQL客户端TypeScriptNode.js浏览器Github开源项目

graphql-request

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

GitHub Action npm 版本

<!-- 开始自动生成的目录,请保留此注释以允许自动更新 --> <!-- 请勿编辑此部分,而是重新运行 doctoc 进行更新 --> <!-- 结束自动生成的目录 -->

亮点

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

安装

npm add graphql-request graphql

TypeScript 设置

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

  1. tsconfig.json 中的 moduleResolution 设置为 "bundler""node16"/"nodenext"
  2. 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, })

知识库

为什么文件上传功能被移除了?它会回来吗?

这个问题中,我们决定使这个库更稳定和易于维护。原则上,这个功能仍在本库的范围内,当我们有时间正确实现这个功能时,它将会回归。

为什么我必须安装 graphql

graphql-request 使用 graphql 包暴露的方法来处理一些内部逻辑。此外,对于 TypeScript 用户来说,graphql 包中的一些类型被用来提供更好的类型定义。

我需要将 GraphQL 文档包装在 graphql-request 导出的 gql 模板中吗?

不需要。它的存在只是为了方便,让你可以获得自动格式化和语法高亮等工具支持。如果出于某些原因需要,你也可以使用 graphql-tag 中的 gql

与 Apollo、Relay 等其他客户端相比,graphql-request 有何不同?

graphql-request是最简单、最小化的GraphQL客户端。它非常适合小型脚本或简单的应用程序。

与Apollo或Relay等GraphQL客户端相比,graphql-request没有内置缓存,也没有与前端框架的集成。它的目标是尽可能保持包和API的最小化。

项目统计

包安装量

<a href="https://npm-compare.com/graphql-request#timeRange=FIVE_YEARS" target="_blank"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/2307920b-567f-46c1-805c-452bad7b8034.png" width="100%" alt="graphql-request的NPM使用趋势" /> </a>

仓库统计

Alt

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多