前言
GraphQL 是一个数据查询和操作语言。它是由 Facebook 开发并在 2015 年公开发布的，现已成为了现代 Web 应用程序中流行的技术之一。
在 GraphQL 生态系统中，有许多工具和库可以协助你构建和管理你的 GraphQL 项目。其中之一就是 @graphql-codegen/typescript-compatibility 包，它可以帮助我们生成 TypeScript 兼容文件。
在本篇文章中，我们将介绍如何使用 @graphql-codegen/typescript-compatibility 包来生成 TypeScript 兼容的代码，并阐述其深度、学习以及指导意义。
安装
在开始使用 @graphql-codegen/typescript-compatibility 包之前，你需要先安装它。你可以使用 npm 安装它：
npm install --save-dev @graphql-codegen/typescript-compatibility
用法
配置
我们需要配置 codegen.yml 文件来告诉 @graphql-codegen/typescript-compatibility 包我们的 GraphQL schema 位置、要生成的文件位置以及生成文件的格式。
以下是一个示例 codegen.yml 文件的配置：
-- -------------------- ---- -------
---------- ----
------- -------------------------------
---------- --------------------
----------
---------------
--------
- ------------
- -----------------------
- --------------------------在这个示例中，我们告诉生成器将 TypeScript 兼容代码输出到 ./gen/types.ts，并将 typescript、typescript-operations 和 typescript-compatibility 插件应用于生成的文件中。
命令行
我们可以使用以下命令来运行 @graphql-codegen/typescript-compatibility 包：
npx graphql-codegen
当你运行这个命令时，生成器将自动读取 codegen.yml 文件中的配置，并生成并输出 TypeScript 兼容代码到指定的位置。
示例代码
以下是一个使用 @graphql-codegen/typescript-compatibility 包的示例 GraphQL 查询：
-- -------------------- ---- -------
- -------------
----- ------------ ---- -
-------- ---- -
--
----
-----
-
-接下来，我们需要使用 graphql-codegen 告诉生成器如何生成 TypeScript 兼容代码：
-- -------------------- ---- -------
- -----------
---------- ----
------- -------------------------------
---------- --------------------
----------
---------------
--------
- ------------
- -----------------------
- --------------------------运行 graphql-codegen 命令后，我们将获得一个 TypeScript 文件，其中包含我们 query.graphql 文件中定义的查询的 TypeScript 类型：
-- -------------------- ---- -------
-- --------
------ ---- --------------------- - -
--- -------
--
------ ---- ------------ - -
----- -
--- -------
----- -------
------ -------
--
--我们可以将这个文件导入到我们的项目中使用。
深度、学习以及指导意义
@graphql-codegen/typescript-compatibility 包为我们提供了 TypeScript 兼容代码的生成工具，使我们可以使用 TypeScript 编写类型安全的代码。通过使用这个工具，我们可以更加安全和方便地使用 GraphQL，从而大大简化我们的开发流程。
同时，这个包和生成工具的使用也教会了我们如何使用 graphql-codegen 来自动化生成代码，这可以大大减少我们的工作量并提高开发效率。
总之，我们强烈建议所有使用 GraphQL 的开发人员学习如何使用 @graphql-codegen/typescript-compatibility 包，以及 graphql-codegen 工具，这将会使你的开发方式更加便捷和安全。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/148472