feat(models): ERR_INVALID_ARG_VALUE

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

Author: unicornware

.eslintrc.base.cjs

@@ -1036,9 +1036,10 @@ const config = {
         'unicorn/error-message': 0,
         'unicorn/explicit-length-check': 0,
         'unicorn/no-array-for-each': 0,
+        'unicorn/no-useless-undefined': 0,
         'unicorn/prefer-at': 0,
         'unicorn/prefer-dom-node-append': 0,
-        'unicorn/no-useless-undefined': 0,
+        'unicorn/prefer-json-parse-buffer': 0,
         'unicorn/string-content': 0
       }
     },

package.json

@@ -77,6 +77,7 @@
     "@commitlint/types": "17.0.0",
     "@faker-js/faker": "7.6.0",
     "@flex-development/mkbuild": "1.0.0-alpha.9",
+    "@flex-development/pkg-types": "1.0.0",
     "@graphql-eslint/eslint-plugin": "3.13.0",
     "@types/chai": "4.3.4",
     "@types/chai-string": "1.4.2",

src/models/__tests__/err-invalid-arg-value.spec.ts

@@ -0,0 +1,71 @@
+/**
+ * @file Unit Tests - ERR_INVALID_ARG_VALUE
+ * @module errnode/models/tests/unit/ERR_INVALID_ARG_VALUE
+ */
+
+import { ErrorCode } from '#src/enums'
+import type { PackageJson } from '@flex-development/pkg-types'
+import { inspect } from 'node-inspect-extracted'
+import fs from 'node:fs'
+import TestSubject from '../err-invalid-arg-value'
+
+describe('unit:models/ERR_INVALID_ARG_VALUE', () => {
+  let name: string
+  let reason: string
+  let value: unknown
+
+  beforeEach(() => {
+    name = 'ip_addr'
+    reason = `${name} should be of type string`
+    value = null
+  })
+
+  it('should return TypeError instance', () => {
+    // Act
+    const result = new TestSubject(name, value)
+
+    // Expect
+    expect(result).to.be.instanceof(TypeError)
+    expect(result).to.have.property('name').equal('TypeError')
+  })
+
+  it('should set error code', () => {
+    expect(new TestSubject(name, value))
+      .to.have.property('code')
+      .equal(ErrorCode.ERR_INVALID_ARG_VALUE)
+  })
+
+  it('should set error message', () => {
+    // Arrange
+    const pkg: PackageJson = JSON.parse(fs.readFileSync('package.json', 'utf8'))
+    const pkgstr: string = inspect(pkg).slice(0, 128) + '...'
+    const props = (name: string) => `props.${name}`
+    const cases: [...ConstructorParameters<typeof TestSubject>, string][] = [
+      [
+        name,
+        value,
+        undefined,
+        `The argument '${name}' is invalid. Received ${value}`
+      ],
+      [
+        props(name),
+        value,
+        undefined,
+        `The property '${props(name)}' is invalid. Received ${value}`
+      ],
+      [
+        name,
+        pkg,
+        reason,
+        `The argument '${name}' ${reason}. Received ${pkgstr}`
+      ]
+    ]
+
+    // Act + Expect
+    cases.forEach(([name, value, reason, expected]) => {
+      expect(new TestSubject(name, value, reason))
+        .to.have.property('message')
+        .equal(expected)
+    })
+  })
+})

src/models/err-invalid-arg-value.ts

@@ -0,0 +1,76 @@
+/**
+ * @file Error Models - ERR_INVALID_ARG_VALUE
+ * @module errnode/models/ERR_INVALID_ARG_VALUE
+ * @see https://github.com/nodejs/node/blob/v19.3.0/lib/internal/errors.js#L1287-L1294
+ */
+
+import { ErrorCode } from '#src/enums'
+import type { MessageFn, NodeError, NodeErrorConstructor } from '#src/types'
+import { createNodeError } from '#src/utils'
+import { inspect } from 'node-inspect-extracted'
+
+/**
+ * `ERR_INVALID_ARG_VALUE` model.
+ *
+ * Thrown when an invalid or unsupported value is passed for a given argument or
+ * property.
+ *
+ * @see https://nodejs.org/api/errors.html#err_invalid_arg_value
+ *
+ * @class
+ *
+ * @param {string} name - Name of invalid argument or property
+ * @param {unknown} value - Value supplied by user
+ * @param {string?} [reason='is invalid'] - Reason `value` is invalid
+ * @return {NodeError<TypeError>} `TypeError` instance
+ */
+const ERR_INVALID_ARG_VALUE: NodeErrorConstructor<
+  TypeErrorConstructor,
+  MessageFn<[string, unknown, string?]>
+> = createNodeError(
+  ErrorCode.ERR_INVALID_ARG_VALUE,
+  TypeError,
+  /**
+   * Creates an [`ERR_INVALID_ARG_VALUE`][1] message.
+   *
+   * [1]: https://nodejs.org/api/errors.html#err_invalid_arg_value
+   *
+   * @param {string} name - Name of invalid argument or property
+   * @param {unknown} value - Value supplied by user
+   * @param {string?} [reason='is invalid'] - Reason `value` is invalid
+   * @return {string} Error message
+   */
+  (name: string, value: unknown, reason: string = 'is invalid'): string => {
+    /**
+     * Inspected {@linkcode value}.
+     *
+     * @see https://nodejs.org/api/util.html#utilinspectobject-options
+     *
+     * @var {string} inspected
+     */
+    let inspected: string = inspect(value)
+
+    /**
+     * Error message.
+     *
+     * @var {string} message
+     */
+    let message: string = 'The'
+
+    // trim inspected value
+    if (inspected.length > 128) inspected = inspected.slice(0, 128) + '...'
+
+    // add stylized invalid argument or property name
+    message += ` ${name.includes('.') ? 'property' : 'argument'} '${name}'`
+
+    // add reason for error
+    if (reason) message += ` ${reason}`
+
+    // add inspected value
+    message += `. Received ${inspected}`
+
+    return message
+  }
+)
+
+export default ERR_INVALID_ARG_VALUE

src/models/index.ts

@@ -12,6 +12,7 @@ export { default as ERR_IMPORT_ASSERTION_TYPE_FAILED } from './err-import-assert
 export { default as ERR_IMPORT_ASSERTION_TYPE_MISSING } from './err-import-assertion-type-missing'
 export { default as ERR_IMPORT_ASSERTION_TYPE_UNSUPPORTED } from './err-import-assertion-type-unsupported'
 export { default as ERR_INCOMPATIBLE_OPTION_PAIR } from './err-incompatible-option-pair'
+export { default as ERR_INVALID_ARG_VALUE } from './err-invalid-arg-value'
 export { default as ERR_INVALID_MODULE_SPECIFIER } from './err-invalid-module-specifier'
 export { default as ERR_INVALID_PACKAGE_CONFIG } from './err-invalid-package-config'
 export { default as ERR_METHOD_NOT_IMPLEMENTED } from './err-method-not-implemented'

yarn.lock

@@ -999,6 +999,7 @@ __metadata:
     "@commitlint/types": "npm:17.0.0"
     "@faker-js/faker": "npm:7.6.0"
     "@flex-development/mkbuild": "npm:1.0.0-alpha.9"
+    "@flex-development/pkg-types": "npm:1.0.0"
     "@flex-development/tutils": "npm:6.0.0-alpha.7"
     "@graphql-eslint/eslint-plugin": "npm:3.13.0"
     "@types/chai": "npm:4.3.4"
@@ -1121,6 +1122,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@flex-development/pkg-types@npm:1.0.0":
+  version: 1.0.0
+  resolution: "@flex-development/pkg-types@npm:1.0.0::__archiveUrl=https%3A%2F%2Fnpm.pkg.github.com%2Fdownload%2F%40flex-development%2Fpkg-types%2F1.0.0%2F596322ff94bcaf29541e3ed76742b4777510121a"
+  peerDependencies:
+    "@flex-development/tutils": ">=6.0.0-alpha.7"
+  checksum: 673e66cbcb1cdfe1529014696687e625e6d57d53f435639a18fd04a50807f08588198485ff35ada7c3a8d33aeeb081d3fe4df58a5a3a8734ae74a363d308a2c6
+  languageName: node
+  linkType: hard
+
 "@flex-development/tutils@npm:6.0.0-alpha.7":
   version: 6.0.0-alpha.7
   resolution: "@flex-development/tutils@npm:6.0.0-alpha.7::__archiveUrl=https%3A%2F%2Fnpm.pkg.github.com%2Fdownload%2F%40flex-development%2Ftutils%2F6.0.0-alpha.7%2F786916dcfd30bf076b5ac74cb31ca4031f74e1f0"