test(types): add TS validation to assure types are properly configured

Author: oscard0m

test/typescript-validate.ts

@@ -0,0 +1,51 @@
+import { Octokit } from "@octokit/core";
+import { throttling } from "../src/index";
+// ************************************************************
+// THIS CODE IS NOT EXECUTED. IT IS FOR TYPECHECKING ONLY
+// ************************************************************
+
+const octokit = new Octokit();
+
+// will be deprecated soon
+// onAbuseLimit()
+throttling(octokit, {
+  throttle: { enabled: true, onRateLimit: () => {}, onAbuseLimit: () => {} },
+});
+
+// onSecondaryLimit()
+throttling(octokit, {
+  throttle: {
+    enabled: true,
+    onRateLimit: () => {},
+    onSecondaryRateLimit: () => {},
+  },
+});
+
+// onSecondaryLimit() and onAbuseLimit() should be a TS Error
+// @ts-expect-error
+throttling(octokit, {
+  throttle: {
+    enabled: true,
+    onRateLimit: () => {},
+    onSecondaryRateLimit: () => {},
+    onAbuseLimit: () => {},
+  },
+});
+
+// onRateLimit() missing should be a TS Error
+// @ts-expect-error
+throttling(octokit, {
+  throttle: {
+    enabled: true,
+    onSecondaryRateLimit: () => {},
+  },
+});
+
+// onSecondaryLimit() and onAbuseLimit() missing should be a TS Error
+throttling(octokit, {
+  // @ts-expect-error
+  throttle: {
+    enabled: true,
+    onRateLimit: () => {},
+  },
+});