feat(types): improve types for ThrottlingOptions to make it more accu…

…rate

src/index.ts

@@ -1,7 +1,7 @@
 // @ts-ignore
 import BottleneckLight from "bottleneck/light";
 import { Octokit } from "@octokit/core";
-
+import { ThrottlingOptions } from "./types";
 import { VERSION } from "./version";
 
 import { wrapRequest } from "./wrap-request";
@@ -45,7 +45,10 @@ const createGroups = function (Bottleneck, common) {
   });
 };
 
-export function throttling(octokit: Octokit, octokitOptions = {}) {
+export function throttling(
+  octokit: Octokit,
+  octokitOptions: ThrottlingOptions
+) {
   const {
     enabled = true,
     Bottleneck = BottleneckLight,

src/types.ts

@@ -0,0 +1,26 @@
+import { OctokitOptions } from "@octokit/core/dist-types/types.d";
+import { Octokit } from "@octokit/core";
+
+declare module "@octokit/core" {
+  interface OctokitOptions {
+    throttle?: ThrottlingOptions;
+  }
+}
+
+type LimitHandler = (
+  retryAfter: number,
+  options: ThrottlingOptions,
+  octokit: Octokit
+) => void;
+
+export interface ThrottlingOptions extends OctokitOptions {
+  throttle: {
+    enabled?: boolean;
+    Bottleneck?: any;
+    id?: string;
+    timeout?: number;
+    connection?: any;
+    onAbuseLimit: LimitHandler;
+    onRateLimit: LimitHandler;
+  };
+}