feat(errors): ERR_ARG_NOT_ITERABLE

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

Author: unicornware

src/__snapshots__/errors.integration.snap

@@ -1,5 +1,7 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`integration:errors > ERR_ARG_NOT_ITERABLE > #toString > should return string representation of error 1`] = `TypeError [ERR_ARG_NOT_ITERABLE]: Query pairs must be iterable`;
+
 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'`;

src/__snapshots__/index.e2e.snap

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

src/__tests__/errors.integration.spec.ts

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

src/errors/__tests__/err-arg-not-iterable.spec-d.ts

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

src/errors/err-arg-not-iterable.ts

@@ -0,0 +1,73 @@
+/**
+ * @file Errors - ERR_ARG_NOT_ITERABLE
+ * @module errnode/errors/ERR_ARG_NOT_ITERABLE
+ * @see https://github.com/nodejs/node/blob/v22.8.0/lib/internal/errors.js#L1122
+ */
+
+import E from '#e'
+import { codes } from '#src/enums'
+import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+
+/**
+ * `ERR_ARG_NOT_ITERABLE` schema.
+ *
+ * @see {@linkcode NodeError}
+ * @see https://nodejs.org/api/errors.html#err_arg_not_iterable
+ *
+ * @extends {NodeError<codes.ERR_ARG_NOT_ITERABLE>}
+ * @extends {TypeError}
+ */
+interface ErrArgNotIterable
+  extends NodeError<codes.ERR_ARG_NOT_ITERABLE>, TypeError {}
+
+/**
+ * `ERR_ARG_NOT_ITERABLE` message arguments.
+ */
+type Args = [arg: unknown]
+
+/**
+ * `ERR_ARG_NOT_ITERABLE` constructor.
+ *
+ * @see {@linkcode ErrArgNotIterable}
+ * @see {@linkcode NodeErrorConstructor}
+ *
+ * @extends {NodeErrorConstructor<ErrArgNotIterable,Args>}
+ */
+interface ErrArgNotIterableConstructor
+  extends NodeErrorConstructor<ErrArgNotIterable, Args> {
+  /**
+   * Create a new `ERR_ARG_NOT_ITERABLE` error.
+   *
+   * @see {@linkcode ErrArgNotIterable}
+   *
+   * @param {unknown} arg
+   *  Description of non-iterable argument, or the non-iterable argument
+   * @return {ErrArgNotIterable}
+   */
+  new (arg: unknown): ErrArgNotIterable
+}
+
+/**
+ * `ERR_ARG_NOT_ITERABLE` model.
+ *
+ * Thrown when an iterable argument (i.e. a value that works with `for...of`
+ * loops) is required, but not provided to a Node.js API.
+ *
+ * @see {@linkcode ErrArgNotIterableConstructor}
+ *
+ * @type {ErrArgNotIterableConstructor}
+ *
+ * @class
+ */
+const ERR_ARG_NOT_ITERABLE: ErrArgNotIterableConstructor = E(
+  codes.ERR_ARG_NOT_ITERABLE,
+  TypeError,
+  '%s must be iterable'
+)
+
+export {
+  ERR_ARG_NOT_ITERABLE as default,
+  type ErrArgNotIterable,
+  type Args as ErrArgNotIterableArgs,
+  type ErrArgNotIterableConstructor
+}

src/errors/index.ts

@@ -4,6 +4,12 @@
  * @see https://nodejs.org/api/errors.html#nodejs-error-codes
  */
 
+export {
+  default as ERR_ARG_NOT_ITERABLE,
+  type ErrArgNotIterable,
+  type ErrArgNotIterableArgs,
+  type ErrArgNotIterableConstructor
+} from './err-arg-not-iterable'
 export {
   default as ERR_ENCODING_NOT_SUPPORTED,
   type ErrEncodingNotSupported,