feat(errors): ERR_ENCODING_NOT_SUPPORTED

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

Author: unicornware

README.md

@@ -143,6 +143,7 @@ This package exports the following identifiers:
 - [`codes`](#codes)
 - [`determineSpecificType`](#determinespecifictypevalue)
 - [`errors`](#errors)
+  - `ERR_ENCODING_NOT_SUPPORTED`
   - `ERR_IMPORT_ASSERTION_TYPE_FAILED`
   - `ERR_IMPORT_ASSERTION_TYPE_MISSING`
   - `ERR_IMPORT_ASSERTION_TYPE_UNSUPPORTED`

src/__snapshots__/errors.integration.snap

@@ -1,5 +1,7 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`integration:errors > ERR_ENCODING_NOT_SUPPORTED > #toString > should return string representation of error 1`] = `RangeError [ERR_ENCODING_NOT_SUPPORTED]: The "null" encoding is not supported`;
+
 exports[`integration:errors > ERR_IMPORT_ASSERTION_TYPE_FAILED > #toString > should return string representation of error 1`] = `TypeError [ERR_IMPORT_ASSERTION_TYPE_FAILED]: Module '\${process.cwd()}/build.config.ts' is not of type 'json'`;
 
 exports[`integration:errors > ERR_IMPORT_ASSERTION_TYPE_MISSING > #toString > should return string representation of error 1`] = `TypeError [ERR_IMPORT_ASSERTION_TYPE_MISSING]: Module '\${process.cwd()}/package.json' needs an import assertion of type 'json'`;

src/__snapshots__/index.e2e.snap

@@ -5,6 +5,7 @@ exports[`e2e:errnode > should expose public api 1`] = `
   "E",
   "codes",
   "syscodes",
+  "ERR_ENCODING_NOT_SUPPORTED",
   "ERR_IMPORT_ASSERTION_TYPE_FAILED",
   "ERR_IMPORT_ASSERTION_TYPE_MISSING",
   "ERR_IMPORT_ASSERTION_TYPE_UNSUPPORTED",

src/__tests__/errors.integration.spec.ts

@@ -19,6 +19,7 @@ describe('integration:errors', () => {
   })
 
   describe.each<[keyof typeof testSubject, ErrorConstructor, ...unknown[]]>([
+    [codes.ERR_ENCODING_NOT_SUPPORTED, RangeError, null],
     [
       codes.ERR_IMPORT_ASSERTION_TYPE_FAILED,
       TypeError,

src/errors/__tests__/err-encoding-not-supported.spec-d.ts

@@ -0,0 +1,41 @@
+/**
+ * @file Type Tests - ERR_ENCODING_NOT_SUPPORTED
+ * @module errnode/errors/tests/unit-d/ERR_ENCODING_NOT_SUPPORTED
+ */
+
+import { codes } from '#src/enums'
+import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+import type * as TestSubject from '../err-encoding-not-supported'
+
+describe('unit-d:errors/ERR_ENCODING_NOT_SUPPORTED', () => {
+  describe('ERR_ENCODING_NOT_SUPPORTED', () => {
+    it('should be ErrEncodingNotSupportedConstructor', () => {
+      expectTypeOf<typeof TestSubject.default>()
+        .toEqualTypeOf<TestSubject.ErrEncodingNotSupportedConstructor>()
+    })
+  })
+
+  describe('ErrEncodingNotSupported', () => {
+    it('should extend NodeError<codes.ERR_ENCODING_NOT_SUPPORTED>', () => {
+      expectTypeOf<TestSubject.ErrEncodingNotSupported>()
+        .toMatchTypeOf<NodeError<codes.ERR_ENCODING_NOT_SUPPORTED>>()
+    })
+
+    it('should extend RangeError', () => {
+      expectTypeOf<TestSubject.ErrEncodingNotSupported>()
+        .toMatchTypeOf<RangeError>()
+    })
+  })
+
+  describe('ErrEncodingNotSupportedConstructor', () => {
+    it('should match NodeErrorConstructor', () => {
+      // Arrange
+      type T = TestSubject.ErrEncodingNotSupported
+      type Args = TestSubject.ErrEncodingNotSupportedArgs
+
+      // Expect
+      expectTypeOf<TestSubject.ErrEncodingNotSupportedConstructor>()
+        .toMatchTypeOf<NodeErrorConstructor<T, Args>>()
+    })
+  })
+})

src/errors/err-encoding-not-supported.ts

@@ -0,0 +1,76 @@
+/**
+ * @file Errors - ERR_ENCODING_NOT_SUPPORTED
+ * @module errnode/errors/ERR_ENCODING_NOT_SUPPORTED
+ * @see https://github.com/nodejs/node/blob/v22.7.0/lib/internal/errors.js#L1198-L1199
+ */
+
+import E from '#e'
+import { codes } from '#src/enums'
+import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+
+/**
+ * `ERR_ENCODING_NOT_SUPPORTED` schema.
+ *
+ * @see {@linkcode NodeError}
+ * @see https://nodejs.org/api/errors.html#err_encoding_not_supported
+ *
+ * @extends {NodeError<codes.ERR_ENCODING_NOT_SUPPORTED>}
+ * @extends {RangeError}
+ */
+interface ErrEncodingNotSupported
+  extends NodeError<codes.ERR_ENCODING_NOT_SUPPORTED>, RangeError {}
+
+/**
+ * `ERR_ENCODING_NOT_SUPPORTED` message arguments.
+ */
+type Args = [encoding: unknown]
+
+/**
+ * `ERR_ENCODING_NOT_SUPPORTED` constructor.
+ *
+ * @see {@linkcode Args}
+ * @see {@linkcode ErrEncodingNotSupported}
+ * @see {@linkcode NodeErrorConstructor}
+ *
+ * @extends {NodeErrorConstructor<ErrEncodingNotSupported,Args>}
+ */
+interface ErrEncodingNotSupportedConstructor
+  extends NodeErrorConstructor<ErrEncodingNotSupported, Args> {
+  /**
+   * Create a new `ERR_ENCODING_NOT_SUPPORTED` error.
+   *
+   * @see {@linkcode ErrEncodingNotSupported}
+   *
+   * @param {unknown} encoding
+   *  The encoding that is not supported
+   * @return {ErrEncodingNotSupported}
+   */
+  new (encoding: unknown): ErrEncodingNotSupported
+}
+
+/**
+ * `ERR_ENCODING_NOT_SUPPORTED` model.
+ *
+ * Thrown when an encoding provided to the `TextDecoder()` API is not one of the
+ * [WHATWG Supported Encodings][1].
+ *
+ * [1]: https://nodejs.org/api/util.html#whatwg-supported-encodings
+ *
+ * @see {@linkcode ErrEncodingNotSupportedConstructor}
+ *
+ * @type {ErrEncodingNotSupportedConstructor}
+ *
+ * @class
+ */
+const ERR_ENCODING_NOT_SUPPORTED: ErrEncodingNotSupportedConstructor = E(
+  codes.ERR_ENCODING_NOT_SUPPORTED,
+  RangeError,
+  'The "%s" encoding is not supported'
+)
+
+export {
+  ERR_ENCODING_NOT_SUPPORTED as default,
+  type ErrEncodingNotSupported,
+  type Args as ErrEncodingNotSupportedArgs,
+  type ErrEncodingNotSupportedConstructor
+}

src/errors/index.ts

@@ -4,6 +4,12 @@
  * @see https://nodejs.org/api/errors.html#nodejs-error-codes
  */
 
+export {
+  default as ERR_ENCODING_NOT_SUPPORTED,
+  type ErrEncodingNotSupported,
+  type ErrEncodingNotSupportedArgs,
+  type ErrEncodingNotSupportedConstructor
+} from './err-encoding-not-supported'
 export {
   default as ERR_IMPORT_ASSERTION_TYPE_FAILED,
   type ErrImportAssertionTypeFailed,