feat(typescript): export WebhookError (#204)

octokit · Aug 16, 2020 · c3b320b · c3b320b
1 parent dfdfc46
commit c3b320b
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 7 deletions.
diff --git a/src/event-handler/receive.ts b/src/event-handler/receive.ts
@@ -4,7 +4,7 @@ import { wrapErrorHandler } from "./wrap-error-handler";
 import {
   WebhookEvent,
   State,
-  OctokitError,
+  WebhookError,
   WebhookEventHandlerError,
 } from "../types";
 import { EventNames } from "../generated/event-names";
@@ -60,7 +60,7 @@ export function receiverHandle(state: State, event: WebhookEvent) {
     return Promise.resolve();
   }
 
-  const errors: OctokitError[] = [];
+  const errors: WebhookError[] = [];
   const promises = hooks.map((handler: Function) => {
     let promise = Promise.resolve(event);
 

diff --git a/src/index.ts b/src/index.ts
@@ -4,7 +4,7 @@ import { middleware } from "./middleware/middleware";
 import { sign } from "./sign/index";
 import { verify } from "./verify/index";
 import { verifyAndReceive } from "./middleware/verify-and-receive";
-import { Options, State, WebhookEvent } from "./types";
+import { Options, State, WebhookEvent, WebhookError } from "./types";
 import { EventNames } from "./generated/event-names";
 import { GetWebhookPayloadTypeFromEvent } from "./generated/get-webhook-payload-type-from-event";
 import { IncomingMessage, ServerResponse } from "http";
@@ -71,6 +71,7 @@ export {
   createWebhooksApi,
   Webhooks,
   WebhookEvent,
+  WebhookError,
   sign,
   verify,
 };
diff --git a/src/middleware/middleware.ts b/src/middleware/middleware.ts
@@ -4,7 +4,7 @@ import { getPayload } from "./get-payload";
 import { verifyAndReceive } from "./verify-and-receive";
 import { debug } from "debug";
 import { IncomingMessage, ServerResponse } from "http";
-import { State, OctokitError, WebhookEventHandlerError } from "../types";
+import { State, WebhookError, WebhookEventHandlerError } from "../types";
 import { EventNames } from "../generated/event-names";
 import AggregateError from "aggregate-error";
 

diff --git a/src/types.ts b/src/types.ts
@@ -29,21 +29,21 @@ export interface State extends Options<any> {
 /**
  * Error object with optional poperties coming from `octokit.request` errors
  */
-export type OctokitError = Error &
+export type WebhookError = Error &
   Partial<RequestError> & {
     /**
      * @deprecated `error.event` is deprecated. Use the `.event` property on the aggregated error instance
      */
     event: WebhookEvent;
   };
 
-export interface WebhookEventHandlerError extends AggregateError<OctokitError> {
+export interface WebhookEventHandlerError extends AggregateError<WebhookError> {
   event: WebhookEvent;
 
   /**
    * @deprecated `error.errors` is deprecated. Use `Array.from(error)`. See https://npm.im/aggregate-error
    */
-  errors: OctokitError[];
+  errors: WebhookError[];
 }
 
 // temporary using a custom AggregateError type.

diff --git a/test/typescript-validate.ts b/test/typescript-validate.ts
@@ -8,6 +8,7 @@ import {
   EventNames,
   EventPayloads,
   WebhookEvent,
+  WebhookError,
 } from "../src/index";
 import { createServer } from "http";
 
@@ -125,3 +126,9 @@ export default async function () {
 
   createServer(webhooks.middleware).listen(3000);
 }
+
+export function webhookErrorTest(error: WebhookError) {
+  const { event, request } = error;
+  console.log(event);
+  console.log(request);
+}