feat(models): ERR_INVALID_RETURN_VALUE

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

Author: unicornware

README.md

@@ -32,6 +32,7 @@ Universal API for creating [Node.js errors][1]
     - [`ERR_INVALID_MODULE_SPECIFIER(request[, reason][, base])`](#err_invalid_module_specifierrequest-reason-base)
     - [`ERR_INVALID_PACKAGE_CONFIG(id[, base][, reason])`](#err_invalid_package_configid-base-reason)
     - [`ERR_INVALID_PACKAGE_TARGET(dir, key, target[, internal][, base])`](#err_invalid_package_targetdir-key-target-internal-base)
+    - [`ERR_INVALID_RETURN_VALUE(expected, name, value)`](#err_invalid_return_valueexpected-name-value)
     - [`ERR_INVALID_URL(input)`](#err_invalid_urlinput)
     - [`ERR_METHOD_NOT_IMPLEMENTED(method)`](#err_method_not_implementedmethod)
     - [`ERR_MISSING_OPTION(option)`](#err_missing_optionoption)
@@ -218,6 +219,7 @@ This package exports the following identifiers:
 - [`ERR_INVALID_MODULE_SPECIFIER`](#err_invalid_module_specifierrequest-reason-base)
 - [`ERR_INVALID_PACKAGE_CONFIG`](#err_invalid_package_configid-base-reason)
 - [`ERR_INVALID_PACKAGE_TARGET`](#err_invalid_package_targetdir-key-target-internal-base)
+- [`ERR_INVALID_RETURN_VALUE`](#err_invalid_return_valueexpected-name-value)
 - [`ERR_INVALID_URL`](#err_invalid_urlinput)
 - [`ERR_METHOD_NOT_IMPLEMENTED`](#err_method_not_implementedmethod)
 - [`ERR_MISSING_OPTION`](#err_missing_optionoption)
@@ -407,6 +409,18 @@ the attempted module resolution.
 
 > **Source**: [`src/models/err-invalid-package-target.ts`](src/models/err-invalid-package-target.ts)
 
+#### `ERR_INVALID_RETURN_VALUE(expected, name, value)`
+
+Thrown when a function does not return an expected value type on execution, such as when a function is expected to
+return a promise.
+
+- `{string}` **`expected`** — Expected return value type
+- `{string}` **`name`** — Name of function that returned invalid value type
+- `{unknown}` **`value`** — Value supplied by user
+- **Returns**: `{NodeError<TypeError>}`
+
+> **Source**: [`src/models/err-invalid-return-value.ts`](src/models/err-invalid-return-value.ts)
+
 #### `ERR_INVALID_URL(input)`
 
 Thrown when an invalid URL is passed to a [WHATWG][11] [`URL` constructor][12] or [`url.parse()`][13] to be parsed.

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

@@ -0,0 +1,43 @@
+/**
+ * @file Unit Tests - ERR_INVALID_RETURN_VALUE
+ * @module errnode/models/tests/unit/ERR_INVALID_RETURN_VALUE
+ */
+
+import { ErrorCode } from '#src/enums'
+import type { NodeError } from '#src/types'
+import { determineSpecificType } from '#src/utils'
+import TestSubject from '../err-invalid-return-value'
+
+describe('unit:models/ERR_INVALID_RETURN_VALUE', () => {
+  let expected: string
+  let name: string
+  let result: NodeError<TypeError>
+  let value: unknown
+
+  beforeEach(() => {
+    expected = 'string'
+    name = 'fn'
+    value = null
+    result = new TestSubject(expected, name, value)
+  })
+
+  it('should return TypeError instance', () => {
+    expect(result).to.be.instanceof(TypeError)
+    expect(result).to.have.property('name').equal('TypeError')
+  })
+
+  it('should set error code', () => {
+    expect(result)
+      .to.have.property('code')
+      .equal(ErrorCode.ERR_INVALID_RETURN_VALUE)
+  })
+
+  it('should set error message', () => {
+    // Arrange
+    const type: string = determineSpecificType(value)
+    const msg: string = `Expected ${expected} to be returned from the '${name}' function but got ${type}.`
+
+    // Expect
+    expect(result).to.have.property('message').equal(msg)
+  })
+})

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

@@ -0,0 +1,48 @@
+/**
+ * @file Error Models - ERR_INVALID_RETURN_VALUE
+ * @module errnode/models/ERR_INVALID_RETURN_VALUE
+ * @see https://github.com/nodejs/node/blob/v19.3.0/lib/internal/errors.js#L1367-L1372
+ */
+
+import { ErrorCode } from '#src/enums'
+import type { MessageFn, NodeError, NodeErrorConstructor } from '#src/types'
+import { createNodeError, determineSpecificType } from '#src/utils'
+
+/**
+ * `ERR_INVALID_RETURN_VALUE` model.
+ *
+ * Thrown when a function does not return an expected value type on execution,
+ * such as when a function is expected to return a promise.
+ *
+ * @see https://nodejs.org/api/errors.html#err_invalid_return_value
+ *
+ * @class
+ *
+ * @param {string} expected - Expected return value type
+ * @param {string} name - Name of function that returned invalid value type
+ * @param {unknown} value - Value supplied by user
+ * @return {NodeError<TypeError>} `TypeError` instance
+ */
+const ERR_INVALID_RETURN_VALUE: NodeErrorConstructor<
+  TypeErrorConstructor,
+  MessageFn<[string, string, unknown]>
+> = createNodeError(
+  ErrorCode.ERR_INVALID_RETURN_VALUE,
+  TypeError,
+  /**
+   * Creates a [`ERR_INVALID_RETURN_VALUE`][1] message.
+   *
+   * [1]: https://nodejs.org/api/errors.html#err_invalid_return_value
+   *
+   * @param {string} expected - Expected return value type
+   * @param {string} name - Name of function that returned invalid value type
+   * @param {unknown} value - Value supplied by user
+   * @return {string} Error message
+   */
+  (expected: string, name: string, value: unknown): string => {
+    // prettier-ignore
+    return `Expected ${expected} to be returned from the '${name}' function but got ${determineSpecificType(value)}.`
+  }
+)
+
+export default ERR_INVALID_RETURN_VALUE

src/models/index.ts

@@ -17,6 +17,7 @@ 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_INVALID_PACKAGE_TARGET } from './err-invalid-package-target'
+export { default as ERR_INVALID_RETURN_VALUE } from './err-invalid-return-value'
 export { default as ERR_INVALID_URL } from './err-invalid-url'
 export { default as ERR_METHOD_NOT_IMPLEMENTED } from './err-method-not-implemented'
 export { default as ERR_MISSING_OPTION } from './err-missing-option'