在前端开发中，使用 GitHub API 是非常常见的操作。然而，如果使用 API 过于频繁，可能会受到 GitHub 的限制。为了解决这个问题，@octokit/plugin-throttling 库应运而生。本文将介绍该库的使用教程，给前端开发人员提供帮助。
什么是 @octokit/plugin-throttling？
@octokit/plugin-throttling 是一个 npm 包，它是 Octokit.js 的一个插件。Octokit.js 是一个用于在浏览器和 Node.js 中与 GitHub API 进行交互的 JavaScript 库。它支持许多不同的插件，包括 @octokit/plugin-throttling。该插件允许我们设置请求速度限制，以避免被 GitHub 限制。
如何安装 @octokit/plugin-throttling？
要使用 @octokit/plugin-throttling，我们需要首先安装 Octokit.js。我们可以使用 npm 安装：
npm install @octokit/rest
安装完成后，我们可以安装该插件：
npm install @octokit/plugin-throttling
如何使用 @octokit/plugin-throttling？
使用 @octokit/plugin-throttling，我们可以设置请求速度限制。这种限制是每段时间内可以发送的请求数量和间隔时间的组合。具体来说，我们需要设置以下三个参数：
requestCount：每个时间段内可以发送的请求的数量。interval：每个时间段的时间长度，以秒为单位。strategy：指定限制策略，可以是leaky-bucket或fixed-window。
以下是一个设置请求速度限制的例子：
-- -------------------- ---- -------
----- ------- - -------------------------
----- ---------- - --------------------------------------
----- --------- - ---------------------------
----- ------- - --- -----------
----- ------ -----------
--------- -
------------ ------------ -------- -- -
--------------------- ----- --------- --- ------- ----------------- -----------------
-- --------------------------- --- -- -
-- ---- ------- ----
--------------------- ----- ------------- -----------
------ -----
-
--
------------- ------------ -------- -- -
------------------- -------- --- ------- ----------------- -----------------
-- --------------------------- --- -- -
-- ---- ------- ----
--------------------- ----- ------------- -----------
------ -----
-
--
-- ----
--------- -----------------------
-- - - -----------
-- -------- - -
-- ---------------------
-- -------------
------------- --
------------- --
--------- --
--
---在这个例子中，我们指定了 requestCount 为 1，interval 为 1，这意味着我们每秒钟最多只能发送一个请求。如果 API 调用限制触发，将在重试后重新尝试，重试次数为 3。如果 GitHub 检测到滥用行为，将不再发出请求（而不是重试）。
我们可以将 octokit 对象用于调用 GitHub API。下面是获取 pull request 列表的例子：
-- -------------------- ---- ------- -------------------- ------ ---------- ----- ---------- -- -------- ---- -- -- - ------------------ -------------------------- -- -------------- -- - ------------------- --------------------------- ---
总结
本文介绍了 @octokit/plugin-throttling 的使用教程，它是一个很有用的工具，可以帮助我们避免被 GitHub 的 API 调用限制。我们可以使用它来设置请求速度限制，以确保 API 调用正常运行。通过本文，希望可以帮助大家更好地使用这个 npm 包。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/96076