Add NextApiHandler type

vercel · Feb 18, 2020 · 58477b6 · 58477b6
1 parent c71fcbe
commit 58477b6
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/packages/next/next-server/lib/utils.ts b/packages/next/next-server/lib/utils.ts
@@ -219,6 +219,12 @@ export type NextApiResponse<T = any> = ServerResponse & {
   clearPreviewData: () => NextApiResponse<T>
 }
 
+/**
+ * Next `API` route handler
+ */
+export type NextApiHandler<T = any> = (req: NextApiRequest, res: NextApiResponse<T>) => void;
+
+
 /**
  * Utils
  */

diff --git a/packages/next/types/index.d.ts b/packages/next/types/index.d.ts
@@ -9,6 +9,7 @@ import {
   NextComponentType,
   NextApiResponse,
   NextApiRequest,
+  NextApiHandler,
   // @ts-ignore This path is generated at build time and conflicts otherwise
 } from '../dist/next-server/lib/utils'
 
@@ -53,6 +54,12 @@ export type PageConfig = {
   }
 }
 
-export { NextPageContext, NextComponentType, NextApiResponse, NextApiRequest }
+export {
+  NextPageContext,
+  NextComponentType,
+  NextApiResponse,
+  NextApiRequest,
+  NextApiHandler,
+}
 
 export default next
-Original file line number
+Diff line change
@@ Expand Up / @@ -219,6 +219,12 @@ export type NextApiResponse<T = any> = ServerResponse & { @@
       clearPreviewData: () => NextApiResponse<T>
     }
+    /**
+     * Next `API` route handler
+     */
+    export type NextApiHandler<T = any> = (req: NextApiRequest, res: NextApiResponse<T>) => void;
     /**
      * Utils
      */
@@ Expand Down @@