feat(interfaces): ErrnoException

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

Author: unicornware

.cspell.json

@@ -52,6 +52,7 @@
     "ESHUTDOWN",
     "ESOCKTNOSUPPORT",
     "Odfijos",
+    "errno",
     "fldv"
   ]
 }

README.md

@@ -22,6 +22,7 @@ Create [Node.js errors][1]
   - [`determineSpecificType(value)`](#determinespecifictypevalue)
 - [Types](#types)
   - [Enums](#enums)
+  - [Interfaces](#interfaces)
   - [Type Defintions](#type-definitions)
 - [Contribute](#contribute)
 
@@ -323,6 +324,10 @@ This package is fully typed with [TypeScript][8]. It exports the following defin
 - [`ErrorCode`](src/enums/error-code.ts)
 - [`SystemErrorCode`](src/enums/error-code-system.ts)
 
+### Interfaces
+
+- [`ErrnoException`](src/interfaces/errno-exception.ts)
+
 ### Type Definitions
 
 - [`NodeError`](src/types/node-error.ts)

src/index.ts

@@ -6,4 +6,5 @@
 export { default as createNodeError } from './create-node-error'
 export { default as determineSpecificType } from './determine-specific-type'
 export * from './enums'
+export * from './interfaces'
 export * from './types'

src/interfaces/__tests__/errno-exception.spec-d.ts

@@ -0,0 +1,37 @@
+/**
+ * @file Type Tests - ErrnoException
+ * @module errnode/interfaces/tests/unit-d/ErrnoException
+ */
+
+import type { SystemErrorCode } from '#src/enums'
+import type TestSubject from '../errno-exception'
+
+describe('unit-d:interfaces/ErrnoException', () => {
+  it('should extend Error', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<Error>()
+  })
+
+  it('should match [code: SystemErrorCode]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('code')
+      .toEqualTypeOf<SystemErrorCode>()
+  })
+
+  it('should match [errno: number]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('errno').toBeNumber()
+  })
+
+  it('should match [message: string]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('message').toBeString()
+  })
+
+  it('should match [path?: string | undefined]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('path')
+      .toEqualTypeOf<string | undefined>()
+  })
+
+  it('should match [syscall: string]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('syscall').toBeString()
+  })
+})

src/interfaces/errno-exception.ts

@@ -0,0 +1,60 @@
+/**
+ * @file Interfaces - ErrnoException
+ * @module errnode/interfaces/ErrnoException
+ */
+
+import type { SystemErrorCode } from '#src/enums'
+
+/**
+ * Node.js exception model.
+ *
+ * @see https://github.com/nodejs/node/blob/v19.3.0/lib/internal/errors.js#L615-L619
+ *
+ * @extends {Error}
+ */
+interface ErrnoException extends Error {
+  /**
+   * System error code.
+   *
+   * [1]: {@link ../enums/error-code-system.ts}
+   *
+   * @see [`SystemErrorCode`][1]
+   */
+  code: SystemErrorCode
+
+  /**
+   * Negative number which corresponds to an error code defined in [libuv Error
+   * handling][1].
+   *
+   * On Windows, the error number provided by the system will be normalized by
+   * libuv.
+   *
+   * [1]: https://docs.libuv.org/en/v1.x/errors.html
+   * [2]: https://nodejs.org/api/util.html#utilgetsystemerrornameerr
+   */
+  errno: number
+
+  /**
+   * Error message.
+   *
+   * Always prefixed by {@linkcode syscall} and {@linkcode code}.
+   *
+   * @override
+   */
+  message: NonNullable<Error['message']>
+
+  /**
+   * Relevant invalid pathname (i.e. a file path when reporting a file system
+   * error).
+   */
+  path?: string | undefined
+
+  /**
+   * Failed [syscall][1] description.
+   *
+   * [1]: https://man7.org/linux/man-pages/man2/syscalls.2.html
+   */
+  syscall: string
+}
+
+export type { ErrnoException as default }

src/interfaces/index.ts

@@ -0,0 +1,6 @@
+/**
+ * @file Entry Point - Interfaces
+ * @module errnode/interfaces
+ */
+
+export type { default as ErrnoException } from './errno-exception'