node_modules

node_modules/@octokit/plugin-throttling/README.md

@@ -0,0 +1,149 @@
+# plugin-throttling.js
+
+> Octokit plugin for GitHub’s recommended request throttling
+
+[![@latest](https://img.shields.io/npm/v/@octokit/plugin-throttling.svg)](https://www.npmjs.com/package/@octokit/plugin-throttling)
+[![Build Status](https://github.com/octokit/plugin-throttling.js/workflows/Test/badge.svg)](https://github.com/octokit/plugin-throttling.js/actions?workflow=Test)
+
+Implements all [recommended best practises](https://developer.github.com/v3/guides/best-practices-for-integrators/) to prevent hitting abuse rate limits.
+
+## Usage
+
+<table>
+<tbody valign=top align=left>
+<tr><th>
+Browsers
+</th><td width=100%>
+
+Load `@octokit/plugin-throttling` and [`@octokit/core`](https://github.com/octokit/core.js) (or core-compatible module) directly from [cdn.pika.dev](https://cdn.pika.dev)
+
+```html
+<script type="module">
+  import { Octokit } from "https://cdn.pika.dev/@octokit/core";
+  import { throttling } from "https://cdn.pika.dev/@octokit/plugin-throttling";
+</script>
+```
+
+</td></tr>
+<tr><th>
+Node
+</th><td>
+
+Install with `npm install @octokit/core @octokit/plugin-throttling`. Optionally replace `@octokit/core` with a core-compatible module.
+
+**Note**: If you use it with `@octokit/rest` v16, install `@octokit/core` as a devDependency. This is only temporary and will no longer be necessary with `@octokit/rest` v17.
+
+```js
+const { Octokit } = require("@octokit/core");
+const { throttling } = require("@octokit/plugin-throttling");
+```
+
+</td></tr>
+</tbody>
+</table>
+
+The code below creates a "Hello, world!" issue on every repository in a given organization. Without the throttling plugin it would send many requests in parallel and would hit rate limits very quickly. But the `@octokit/plugin-throttling` slows down your requests according to the official guidelines, so you don't get blocked before your quota is exhausted.
+
+The `throttle.onAbuseLimit` and `throttle.onRateLimit` options are required. Return `true` to automatically retry the request after `retryAfter` seconds.
+
+```js
+const MyOctokit = Octokit.plugin(throttling);
+
+const octokit = new MyOctokit({
+  auth: `secret123`,
+  throttle: {
+    onRateLimit: (retryAfter, options) => {
+      console.warn(`Request quota exhausted for request ${options.method} ${options.url}`)
+
+      if (options.request.retryCount === 0) { // only retries once
+        console.log(`Retrying after ${retryAfter} seconds!`)
+        return true
+      }
+    },
+    onAbuseLimit: (retryAfter, options) => {
+      // does not retry, only logs a warning
+      console.warn(`Abuse detected for request ${options.method} ${options.url}`)
+    }
+  }
+})
+
+async function createIssueOnAllRepos (org) {
+  const repos = await octokit.paginate(octokit.repos.listForOrg.endpoint({ org }))
+  return Promise.all(repos.forEach(({ name } => {
+    octokit.issues.create({
+      owner,
+      repo: name,
+      title: 'Hello, world!'
+    })
+  })))
+}
+```
+
+Pass `{ throttle: { enabled: false } }` to disable this plugin.
+
+### Clustering
+
+Enabling Clustering support ensures that your application will not go over rate limits **across Octokit instances and across Nodejs processes**.
+
+First install either `redis` or `ioredis`:
+
+```
+# NodeRedis (https://github.com/NodeRedis/node_redis)
+npm install --save redis
+
+# or ioredis (https://github.com/luin/ioredis)
+npm install --save ioredis
+```
+
+Then in your application:
+
+```js
+const Bottleneck = require("bottleneck");
+const Redis = require("redis");
+
+const client = Redis.createClient({
+  /* options */
+});
+const connection = new Bottleneck.RedisConnection({ client });
+connection.on("error", err => console.error(err));
+
+const octokit = new MyOctokit({
+  auth: 'secret123'
+  throttle: {
+    onAbuseLimit: (retryAfter, options) => {
+      /* ... */
+    },
+    onRateLimit: (retryAfter, options) => {
+      /* ... */
+    },
+
+    // The Bottleneck connection object
+    connection,
+
+    // A "throttling ID". All octokit instances with the same ID
+    // using the same Redis server will share the throttling.
+    id: "my-super-app",
+
+    // Otherwise the plugin uses a lighter version of Bottleneck without Redis support
+    Bottleneck
+  }
+});
+
+// To close the connection and allow your application to exit cleanly:
+await connection.disconnect();
+```
+
+To use the `ioredis` library instead:
+
+```js
+const Redis = require("ioredis");
+const client = new Redis({
+  /* options */
+});
+const connection = new Bottleneck.IORedisConnection({ client });
+connection.on("error", (err) => console.error(err));
+```
+
+## LICENSE
+
+[MIT](LICENSE)