feat(types): NodeErrorConstructor

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

package.json

@@ -64,6 +64,7 @@
     "typecheck:watch": "vitest typecheck"
   },
   "dependencies": {
+    "@flex-development/tutils": "6.0.0-alpha.7",
     "node-inspect-extracted": "2.0.0"
   },
   "devDependencies": {
@@ -72,7 +73,6 @@
     "@commitlint/types": "17.0.0",
     "@faker-js/faker": "7.6.0",
     "@flex-development/mkbuild": "1.0.0-alpha.9",
-    "@flex-development/tutils": "6.0.0-alpha.7",
     "@graphql-eslint/eslint-plugin": "3.13.0",
     "@types/chai": "4.3.4",
     "@types/chai-string": "1.4.2",

src/types/__tests__/node-error-constructor.spec-d.ts

@@ -0,0 +1,30 @@
+/**
+ * @file Unit Tests - NodeErrorConstructor
+ * @module create-node-error/types/tests/unit-d/NodeErrorConstructor
+ */
+
+import type NodeError from '../node-error'
+import type TestSubject from '../node-error-constructor'
+
+describe('unit-d:types/NodeErrorConstructor', () => {
+  it('should extract parameters of type any[] if M extends string', () => {
+    expectTypeOf<TestSubject>().parameters.toEqualTypeOf<any[]>()
+    expectTypeOf<TestSubject>().constructorParameters.toEqualTypeOf<any[]>()
+  })
+
+  it('should extract parameters of type Parameters<M> if M extends MessageFn', () => {
+    type B = TypeErrorConstructor
+    type M = (ext: string, path: string) => string
+    type P = Parameters<M>
+
+    expectTypeOf<TestSubject<B, M>>().parameters.toEqualTypeOf<P>()
+    expectTypeOf<TestSubject<B, M>>().constructorParameters.toEqualTypeOf<P>()
+  })
+
+  it('should return NodeError<T>', () => {
+    expectTypeOf<TestSubject>().returns.toEqualTypeOf<NodeError>()
+    expectTypeOf<TestSubject<TypeErrorConstructor>>().returns.toEqualTypeOf<
+      NodeError<TypeError>
+    >()
+  })
+})

src/types/index.ts

@@ -5,3 +5,4 @@
 
 export type { default as MessageFn } from './fn-message'
 export type { default as NodeError } from './node-error'
+export type { default as NodeErrorConstructor } from './node-error-constructor'

src/types/node-error-constructor.ts

@@ -0,0 +1,28 @@
+/**
+ * @file Type Definitions - NodeErrorConstructor
+ * @module create-node-error/types/NodeErrorConstructor
+ */
+
+import type { Overwrite } from '@flex-development/tutils'
+import type MessageFn from './fn-message'
+import type NodeError from './node-error'
+
+/**
+ * Node.js error constructor type.
+ *
+ * @template B - Error constructor type
+ * @template M - Error message type
+ * @template T - Error base type
+ *
+ * @extends {Overwrite<B, B>}
+ */
+type NodeErrorConstructor<
+  B extends ErrorConstructor = ErrorConstructor,
+  M extends MessageFn | string = string,
+  T extends B['prototype'] = B['prototype']
+> = Overwrite<B, B> & {
+  new (...args: M extends MessageFn ? Parameters<M> : any[]): NodeError<T>
+  (...args: M extends MessageFn ? Parameters<M> : any[]): NodeError<T>
+}
+
+export type { NodeErrorConstructor as default }