feat(typescript): types for `octokit.hook.{before,after,error,wrap}("…

…request", () => {})` methods
octokit · Mar 5, 2021 · c245588 · c245588
1 parent 66910dc
commit c245588
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -6,6 +6,7 @@ import { createTokenAuth } from "@octokit/auth-token";
 
 import {
   Constructor,
+  Hooks,
   OctokitOptions,
   OctokitPlugin,
   RequestParameters,
@@ -70,7 +71,7 @@ export class Octokit {
   }
 
   constructor(options: OctokitOptions = {}) {
-    const hook = new Collection();
+    const hook = new Collection<Hooks>();
     const requestDefaults: Required<RequestParameters> = {
       baseUrl: request.endpoint.DEFAULTS.baseUrl,
       headers: {},
@@ -175,7 +176,7 @@ export class Octokit {
     error: (message: string, additionalInfo?: object) => any;
     [key: string]: any;
   };
-  hook: HookCollection;
+  hook: HookCollection<Hooks>;
 
   // TODO: type `octokit.auth` based on passed options.authStrategy
   auth: (...args: unknown[]) => Promise<unknown>;

diff --git a/src/types.ts b/src/types.ts
@@ -1,4 +1,5 @@
 import * as OctokitTypes from "@octokit/types";
+import { RequestError } from "@octokit/request-error";
 
 import { Octokit } from ".";
 
@@ -49,3 +50,11 @@ export type OctokitPlugin = (
   octokit: Octokit,
   options: OctokitOptions
 ) => { [key: string]: any } | void;
+
+export type Hooks = {
+  request: {
+    Options: OctokitTypes.EndpointOptions;
+    Result: OctokitTypes.OctokitResponse<any>;
+    Error: RequestError | Error;
+  };
+};