feat(ts): [NodeErrorConstructor] allow custom util.format args type

- https://nodejs.org/api/util.html#utilformatformat-args

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

Author: unicornware

README.md

@@ -301,7 +301,7 @@ constructor arguments are passed to [`util.format`][7] instead.
 
 - `{ErrorCode}` **`code`** — Node.js error code
 - `{B extends ErrorConstructor}` **`Base`** — Error base class
-- `{M extends MessageFn | string}` **`message`** — Error message or message function
+- `{M extends any[] | MessageFn | string}` **`message`** — Error message or message function
 - **Returns**: `{NodeErrorConstructor<B, M>}` `NodeError` constructor
 
 > **Source**: [`src/create-node-error.ts`](src/create-node-error.ts)

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

@@ -12,6 +12,15 @@ describe('unit-d:types/NodeErrorConstructor', () => {
     expectTypeOf<TestSubject>().constructorParameters.toEqualTypeOf<any[]>()
   })
 
+  it('should extract parameters of type M if M extends any[]', () => {
+    // Arrange
+    type B = ErrorConstructor
+    type M = [string, string, string]
+
+    expectTypeOf<TestSubject<B, M>>().parameters.toEqualTypeOf<M>()
+    expectTypeOf<TestSubject<B, M>>().constructorParameters.toEqualTypeOf<M>()
+  })
+
   it('should extract parameters of type Parameters<M> if M extends MessageFn', () => {
     type B = TypeErrorConstructor
     type M = (ext: string, path: string) => string

src/types/node-error-constructor.ts

@@ -7,22 +7,39 @@ import type { Overwrite } from '@flex-development/tutils'
 import type MessageFn from './fn-message'
 import type NodeError from './node-error'
 
+/**
+ * {@linkcode NodeErrorConstructor} arguments helper.
+ *
+ * [1]: https://nodejs.org/api/util.html#utilformatformat-args
+ *
+ * @template M - Error message type, [`util.format`][1] arguments type, or
+ * custom message function parameters type
+ */
+type Args<M extends any[] | MessageFn | string> = M extends MessageFn
+  ? Parameters<M>
+  : M extends any[]
+  ? M
+  : any[]
+
 /**
  * Node.js error constructor type.
  *
+ * [1]: https://nodejs.org/api/util.html#utilformatformat-args
+ *
  * @template B - Error base class type
- * @template M - Error message type
+ * @template M - Error message type, [`util.format`][1] arguments type, or
+ * custom message function parameters type
  * @template T - Error base type
  *
  * @extends {Overwrite<B, B>}
  */
 type NodeErrorConstructor<
   B extends ErrorConstructor = ErrorConstructor,
-  M extends MessageFn | string = string,
+  M extends any[] | MessageFn | string = MessageFn,
   T extends B['prototype'] = B['prototype']
 > = Overwrite<B, B> & {
-  (...args: M extends MessageFn ? Parameters<M> : any[]): NodeError<T>
-  new (...args: M extends MessageFn ? Parameters<M> : any[]): NodeError<T>
+  (...args: Args<M>): NodeError<T>
+  new (...args: Args<M>): NodeError<T>
   readonly prototype: NodeError<T>
 }
 

src/utils/create-node-error.ts

@@ -21,7 +21,8 @@ import type { MessageFn, NodeError, NodeErrorConstructor } from '#src/types'
  * [2]: https://nodejs.org/api/util.html#utilformatformat-args
  *
  * @template B - Error base class type
- * @template M - Error message type
+ * @template M - Error message type, [`util.format`][2] arguments type, or
+ * custom message function parameters type
  * @template T - Error base type
  *
  * @constructs NodeError<T>
@@ -33,7 +34,7 @@ import type { MessageFn, NodeError, NodeErrorConstructor } from '#src/types'
  */
 function createNodeError<
   B extends ErrorConstructor = ErrorConstructor,
-  M extends MessageFn | string = MessageFn | string,
+  M extends any[] | MessageFn | string = MessageFn,
   T extends B['prototype'] = B['prototype']
 >(code: ErrorCode, Base: B, message: M): NodeErrorConstructor<B, M, T> {
   /**
@@ -44,12 +45,12 @@ function createNodeError<
    * @class
    * @implements {NodeError<T>}
    *
-   * @param {any[] | Parameters<M>} args - `message` params if `message` is a
-   * function; [`util.format`][1] arguments if `message` is a string
+   * @param {any[] | M | Parameters<M>} args - `message` params if `message` is
+   * a function; [`util.format`][1] arguments if `message` is a string
    * @return {NodeError<T>} Node.js error instance
    */
   function NodeError(
-    ...args: M extends MessageFn ? Parameters<M> : any[]
+    ...args: M extends MessageFn ? Parameters<M> : M extends any[] ? M : any[]
   ): NodeError<T> {
     /**
      * Node.js error instance.