feat: deprecate createWebhooksApi() (#511)

octokit · Mar 28, 2021 · f8f3d15 · f8f3d15
1 parent f5f55b6
commit f8f3d15
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 7 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -65,7 +65,13 @@ class Webhooks<TTransformed> {
   }
 }
 
-const createWebhooksApi = Webhooks.prototype.constructor;
+/** @deprecated `createWebhooksApi()` is deprecated and will be removed in a future release of `@octokit/webhooks`, please use the `Webhooks` class instead */
+const createWebhooksApi = <TTransformed>(options: Options<TTransformed>) => {
+  console.error(
+    "[@octokit/webhooks] `createWebhooksApi()` is deprecated and will be removed in a future release of `@octokit/webhooks`, please use the `Webhooks` class instead"
+  );
+  return new Webhooks<TTransformed>(options);
+};
 
 export {
   createEventHandler,

diff --git a/test/typescript-validate.ts b/test/typescript-validate.ts
@@ -2,7 +2,6 @@ import {
   Webhooks,
   createEventHandler,
   createMiddleware,
-  createWebhooksApi,
   sign,
   verify,
   EmitterWebhookEvent,
@@ -78,11 +77,6 @@ export default async function () {
     },
   });
 
-  // Check named exports of new API work
-  createWebhooksApi({
-    secret: "blah",
-  });
-
   createEventHandler({ secret: "blah" });
 
   createMiddleware({

diff --git a/test/unit/deprecation.test.ts b/test/unit/deprecation.test.ts
@@ -0,0 +1,12 @@
+import { createWebhooksApi } from "../../src";
+
+describe("Deprecated methods", () => {
+  test("createWebhooksApi", () => {
+    const spy = jest.spyOn(console, "error");
+    createWebhooksApi({ secret: "foo" });
+    expect(spy).toBeCalledWith(
+      "[@octokit/webhooks] `createWebhooksApi()` is deprecated and will be removed in a future release of `@octokit/webhooks`, please use the `Webhooks` class instead"
+    );
+    spy.mockClear();
+  });
+});