介绍
GitHub 上最近发布了一个 npm 包 @octokit/webhooks-definitions，它提供了开发人员使用的规范化 webhook 数据定义。通过使用这个包，开发人员可以轻松地识别 GitHub Webhooks 端点接收到的事件类型和相应的有效负载。
在本篇文章中，我们将介绍如何使用 @octokit/webhooks-definitions 包，摆脱令人头疼的 webhook 数据结构，从而使您的 webhook 处理更加清晰和易于维护。
安装
首先，您需要在项目中安装 @octokit/webhooks-definitions。您可以使用 npm 或 yarn 进行安装。
npm install @octokit/webhooks-definitions
or
yarn add @octokit/webhooks-definitions
使用
@octokit/webhooks-definitions 提供了常见的 GitHub Webhooks 事件类型和它们的有效负载格式。在处理 webhook 事件时，您可以使用这个包来识别事件类型和有效负载。
下面是一个简单示例，演示如何使用 @octokit/webhooks-definitions 包。
-- -------------------- ---- -------
----- - -------- - - -----------------------------
----- - ---- - - ------------------------------------------------
----- -------- - --- ----------
------- --------------
----- ------------
---
----------------- ----- -- ------- -- -- -
--------------------- ---- ----- --- -----------------------------
---
在这个示例中，我们首先引入 @octokit/webhooks 和 push 定义，然后初始化 Webhooks 实例。我们在 Webhooks 实例上注册 push 事件，然后处理接收到的有效负载。
深度
@octokit/webhooks-definitions 包提供了很多常见事件类型的定义，并且还提供了与 GitHub API 相关的类型和定义。如果您没有使用这个包，您将会面临处理大量 webhook 数据结构的复杂问题，而这个包可以使这些问题变得容易一些。
另外，当您使用 @octokit/webhooks-definitions 包时，您可以继续使用您喜欢的 Webhooks 库，因为 @octokit/webhooks-definitions 包与 Webhooks 库没有直接的依赖关系。这意味着您可以使用 @octokit/webhooks-definitions 包可以与您现有的代码库紧密集成，并且不需要更改或重构代码库。
学习与指导意义
当您使用 @octokit/webhooks-definitions 这个 npm 包时，首先要了解如何处理 webhook 事件。这些事件可能与 GitHub API 相对应，或者只是您的应用程序所关心的事件。
当您理解了如何处理这些事件之后，您将能够更好地使用 @octokit/webhooks-definitions 包中提供的定义，从而实现更加高效和清晰的代码。
示例代码
-- -------------------- ---- -------
----- - -------- - - -----------------------------
----- - ------ - - ------------------------------------------------
----- -------- - --- ----------
------- --------------
----- ------------
---
------------------- ----- -- ------- -- -- -
------------------ ------------------ -------------------------
---
在这个示例中，我们监听 issues 事件类型，并在事件被触发时打印事件标题和动作类型。这个示例只是介绍 @octokit/webhooks-definitions 包的基本用法，您可以在自己的应用程序中更多地使用它。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/114912