feat(errors): ERR_INVALID_TUPLE

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

README.md

@@ -161,6 +161,7 @@ This package exports the following identifiers:
   - `ERR_INVALID_PACKAGE_TARGET`
   - `ERR_INVALID_RETURN_VALUE`
   - `ERR_INVALID_THIS`
+  - `ERR_INVALID_TUPLE`
   - `ERR_INVALID_URL_SCHEME`
   - `ERR_INVALID_URL`
   - `ERR_METHOD_NOT_IMPLEMENTED`

src/__snapshots__/errors.integration.snap

@@ -36,6 +36,8 @@ exports[`integration:errors > ERR_INVALID_RETURN_VALUE > #toString > should retu
 
 exports[`integration:errors > ERR_INVALID_THIS > #toString > should return string representation of error 1`] = `TypeError [ERR_INVALID_THIS]: Value of "this" must be of type URLSearchParams`;
 
+exports[`integration:errors > ERR_INVALID_TUPLE > #toString > should return string representation of error 1`] = `TypeError [ERR_INVALID_TUPLE]: Each query pair must be an iterable [name, value] tuple`;
+
 exports[`integration:errors > ERR_INVALID_URL > #toString > should return string representation of error 1`] = `TypeError [ERR_INVALID_URL]: Invalid URL`;
 
 exports[`integration:errors > ERR_INVALID_URL_SCHEME > #toString > should return string representation of error 1`] = `TypeError [ERR_INVALID_URL_SCHEME]: The URL must be of scheme file`;

src/__snapshots__/index.e2e.snap

@@ -23,6 +23,7 @@ exports[`e2e:errnode > should expose public api 1`] = `
   "ERR_INVALID_PACKAGE_TARGET",
   "ERR_INVALID_RETURN_VALUE",
   "ERR_INVALID_THIS",
+  "ERR_INVALID_TUPLE",
   "ERR_INVALID_URL",
   "ERR_INVALID_URL_SCHEME",
   "ERR_METHOD_NOT_IMPLEMENTED",

src/__tests__/errors.integration.spec.ts

@@ -84,6 +84,7 @@ describe('integration:errors', () => {
     ],
     [codes.ERR_INVALID_RETURN_VALUE, TypeError, 'null', 'body', 13],
     [codes.ERR_INVALID_THIS, TypeError, 'URLSearchParams'],
+    [codes.ERR_INVALID_TUPLE, TypeError, 'Each query pair', '[name, value]'],
     [codes.ERR_INVALID_URL, TypeError, pathe.sep, 'http://[127.0.0.1]:8000'],
     [codes.ERR_INVALID_URL_SCHEME, TypeError, 'file'],
     [codes.ERR_METHOD_NOT_IMPLEMENTED, Error, '_transform()'],

src/errors/__tests__/err-invalid-tuple.spec-d.ts

@@ -0,0 +1,41 @@
+/**
+ * @file Type Tests - ERR_INVALID_TUPLE
+ * @module errnode/errors/tests/unit-d/ERR_INVALID_TUPLE
+ */
+
+import { codes } from '#src/enums'
+import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+import type * as TestSubject from '../err-invalid-tuple'
+
+describe('unit-d:errors/ERR_INVALID_TUPLE', () => {
+  describe('ERR_INVALID_TUPLE', () => {
+    it('should be ErrInvalidTupleConstructor', () => {
+      expectTypeOf<typeof TestSubject.default>()
+        .toEqualTypeOf<TestSubject.ErrInvalidTupleConstructor>()
+    })
+  })
+
+  describe('ErrInvalidTuple', () => {
+    it('should extend NodeError<codes.ERR_INVALID_TUPLE>', () => {
+      expectTypeOf<TestSubject.ErrInvalidTuple>()
+        .toMatchTypeOf<NodeError<codes.ERR_INVALID_TUPLE>>()
+    })
+
+    it('should extend TypeError', () => {
+      expectTypeOf<TestSubject.ErrInvalidTuple>()
+        .toMatchTypeOf<TypeError>()
+    })
+  })
+
+  describe('ErrInvalidTupleConstructor', () => {
+    it('should match NodeErrorConstructor', () => {
+      // Arrange
+      type T = TestSubject.ErrInvalidTuple
+      type Args = TestSubject.ErrInvalidTupleArgs
+
+      // Expect
+      expectTypeOf<TestSubject.ErrInvalidTupleConstructor>()
+        .toMatchTypeOf<NodeErrorConstructor<T, Args>>()
+    })
+  })
+})

src/errors/err-invalid-tuple.ts

@@ -0,0 +1,79 @@
+/**
+ * @file Errors - ERR_INVALID_TUPLE
+ * @module errnode/errors/ERR_INVALID_TUPLE
+ * @see https://github.com/nodejs/node/blob/v22.8.0/lib/internal/errors.js#L1530
+ */
+
+import E from '#e'
+import { codes } from '#src/enums'
+import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+
+/**
+ * `ERR_INVALID_TUPLE` schema.
+ *
+ * @see {@linkcode NodeError}
+ * @see https://nodejs.org/api/errors.html#err_invalid_tuple
+ *
+ * @extends {NodeError<codes.ERR_INVALID_TUPLE>}
+ * @extends {TypeError}
+ */
+interface ErrInvalidTuple
+  extends NodeError<codes.ERR_INVALID_TUPLE>, TypeError {}
+
+/**
+ * `ERR_INVALID_TUPLE` message arguments.
+ */
+type Args = [description: string, tuple: string]
+
+/**
+ * `ERR_INVALID_TUPLE` constructor.
+ *
+ * @see {@linkcode ErrInvalidTuple}
+ * @see {@linkcode NodeErrorConstructor}
+ *
+ * @extends {NodeErrorConstructor<ErrInvalidTuple,Args>}
+ */
+interface ErrInvalidTupleConstructor
+  extends NodeErrorConstructor<ErrInvalidTuple, Args> {
+  /**
+   * Create a new `ERR_INVALID_TUPLE` error.
+   *
+   * @see {@linkcode ErrInvalidTuple}
+   *
+   * @param {string} description
+   *  Description of required tuple
+   * @param {string} tuple
+   *  String representation of tuple
+   * @return {ErrInvalidTuple}
+   */
+  new (description: string, tuple: string): ErrInvalidTuple
+}
+
+/**
+ * `ERR_INVALID_TUPLE` model.
+ *
+ * Thrown when an element in the iterable provided to the [WHATWG][whatwg]
+ * [`URLSearchParams` constructor][constructor] did not represent a
+ * `[name, value]` tuple.
+ *
+ * [constructor]: https://nodejs.org/api/url.html#new-urlsearchparamsiterable
+ * [whatwg]: https://nodejs.org/api/url.html#the-whatwg-url-api
+ *
+ * @see {@linkcode ErrInvalidTupleConstructor}
+ *
+ * @type {ErrInvalidTupleConstructor}
+ *
+ * @class
+ */
+const ERR_INVALID_TUPLE: ErrInvalidTupleConstructor = E(
+  codes.ERR_INVALID_TUPLE,
+  TypeError,
+  '%s must be an iterable %s tuple'
+)
+
+export {
+  ERR_INVALID_TUPLE as default,
+  type ErrInvalidTuple,
+  type Args as ErrInvalidTupleArgs,
+  type ErrInvalidTupleConstructor
+}

src/errors/index.ts

@@ -112,6 +112,12 @@ export {
   type ErrInvalidThisArgs,
   type ErrInvalidThisConstructor
 } from './err-invalid-this'
+export {
+  default as ERR_INVALID_TUPLE,
+  type ErrInvalidTuple,
+  type ErrInvalidTupleArgs,
+  type ErrInvalidTupleConstructor
+} from './err-invalid-tuple'
 export {
   default as ERR_INVALID_URL,
   type ErrInvalidUrl,