Strictly type createError (#89)

* strictly type around code and statusCode * add test around strictly typed code and statusCode * narrower type to test * stricter generics constraint
fastify · Dec 7, 2022 · 0569016 · 0569016
1 parent caa1c8b
commit 0569016
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 10 deletions.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1,4 +1,7 @@
-type CreateError = (code: string, message: string, statusCode?: number, Base?: Error) => createError.FastifyErrorConstructor
+declare function createError<C extends string, SC extends number>(code: C, message: string, statusCode: SC, Base?: Error): createError.FastifyErrorConstructor<{ code: C; statusCode: SC }>;
+declare function createError<C extends string>(code: C, message: string, statusCode?: number, Base?: Error): createError.FastifyErrorConstructor<{ code: C; }>;
+
+type CreateError = typeof createError;
 
 declare namespace createError {
   export interface FastifyError extends Error {
@@ -7,15 +10,14 @@ declare namespace createError {
     statusCode?: number;
   }
 
-  export interface FastifyErrorConstructor {
-    new(a?: any, b?: any, c?: any): FastifyError;
-    (a?: any, b?: any, c?: any): FastifyError;
-    readonly prototype: FastifyError;
+  export interface FastifyErrorConstructor<E extends { code: string; statusCode?: number } = { code: string; statusCode?: number }> {
+    new (a?: any, b?: any, c?: any): FastifyError & E;
+    (a?: any, b?: any, c?: any): FastifyError & E;
+    readonly prototype: FastifyError & E;
   }
 
   export const createError: CreateError
   export { createError as default }
 }
 
-declare function createError(...params: Parameters<CreateError>): ReturnType<CreateError>
 export = createError
diff --git a/types/index.test-d.ts b/types/index.test-d.ts
@@ -2,9 +2,17 @@ import createError, { FastifyError, FastifyErrorConstructor } from '..'
 import { expectType } from 'tsd'
 
 const CustomError = createError('ERROR_CODE', 'message')
-expectType<FastifyErrorConstructor>(CustomError)
+expectType<FastifyErrorConstructor<{ code: 'ERROR_CODE' }>>(CustomError)
 const err = new CustomError()
-expectType<FastifyError>(err)
-expectType<string>(err.code)
+expectType<FastifyError & { code: 'ERROR_CODE' }>(err)
+expectType<'ERROR_CODE'>(err.code)
 expectType<string>(err.message)
-expectType<number>(err.statusCode!)
+expectType<number>(err.statusCode!)
+
+const CustomTypedError = createError('OTHER_CODE', 'message', 400)
+expectType<FastifyErrorConstructor<{ code: 'OTHER_CODE'; statusCode: 400 }>>(CustomTypedError)
+const typed = new CustomTypedError()
+expectType<FastifyError & { code: 'OTHER_CODE'; statusCode: 400 }>(typed)
+expectType<'OTHER_CODE'>(typed.code)
+expectType<string>(typed.message)
+expectType<400>(typed.statusCode)