docs: types

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

Author: unicornware

README.md

@@ -17,6 +17,8 @@ Create [Node.js errors][1]
 - [Use](#use)
 - [API](#api)
 - [Types](#types)
+  - [Enums](#enums)
+  - [Type Defintions](#type-definitions)
 - [Contribute](#contribute)
 
 ## What is this?
@@ -64,7 +66,17 @@ yarn add @flex-development/errnode@flex-development/errnode
 
 ## Types
 
-This package is fully typed with [TypeScript][7].
+This package is fully typed with [TypeScript][7]. It exports the following definitions:
+
+### Enums
+
+- [`ErrorCode`](src/enums/error-code.ts)
+
+### Type Definitions
+
+- [`NodeError`](src/types/node-error.ts)
+- [`NodeErrorConstructor`](src/types/node-error-constructor.ts)
+- [`MessageFn`](src/types/fn-message.ts)
 
 ## Contribute
 

src/types/fn-message.ts

@@ -4,12 +4,12 @@
  */
 
 /**
- * Formats an error message.
+ * Creates an error message.
  *
- * @template Args - Function parameters
+ * @template Args - Function parameters type
  *
  * @param {Args} args - Function parameters
- * @return {string} Formatted error message
+ * @return {string} Error message
  */
 type MessageFn<Args extends any[] = any[]> = (...args: Args) => string
 

src/types/node-error-constructor.ts

@@ -21,10 +21,9 @@ type NodeErrorConstructor<
   M extends MessageFn | string = string,
   T extends B['prototype'] = B['prototype']
 > = Overwrite<B, B> & {
-  readonly prototype: NodeError<T>
-
-  new (...args: M extends MessageFn ? Parameters<M> : any[]): NodeError<T>
   (...args: M extends MessageFn ? Parameters<M> : any[]): NodeError<T>
+  new (...args: M extends MessageFn ? Parameters<M> : any[]): NodeError<T>
+  readonly prototype: NodeError<T>
 }
 
 export type { NodeErrorConstructor as default }