feat(models): ERR_INVALID_URL

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

Author: unicornware

.eslintrc.base.cjs

@@ -1035,6 +1035,7 @@ const config = {
         'unicorn/error-message': 0,
         'unicorn/explicit-length-check': 0,
         'unicorn/no-array-for-each': 0,
+        'unicorn/no-hex-escape': 0,
         'unicorn/no-useless-undefined': 0,
         'unicorn/prefer-at': 0,
         'unicorn/prefer-dom-node-append': 0,

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_URL(input)`](#err_invalid_urlinput)
     - [`ERR_METHOD_NOT_IMPLEMENTED(method)`](#err_method_not_implementedmethod)
     - [`ERR_MISSING_OPTION(option)`](#err_missing_optionoption)
     - [`ERR_MODULE_NOT_FOUND(id, base[, type])`](#err_module_not_foundid-base-type)
@@ -216,6 +217,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_URL`](#err_invalid_urlinput)
 - [`ERR_METHOD_NOT_IMPLEMENTED`](#err_method_not_implementedmethod)
 - [`ERR_MISSING_OPTION`](#err_missing_optionoption)
 - [`ERR_MODULE_NOT_FOUND`](#err_module_not_foundid-base-type)
@@ -248,6 +250,7 @@ import {
   ERR_INVALID_MODULE_SPECIFIER,
   ERR_INVALID_PACKAGE_CONFIG,
   ERR_INVALID_PACKAGE_TARGET,
+  ERR_INVALID_URL,
   ERR_MODULE_NOT_FOUND,
   ERR_NETWORK_IMPORT_DISALLOWED,
   ERR_PACKAGE_IMPORT_NOT_DEFINED,
@@ -402,6 +405,15 @@ the attempted module resolution.
 
 > **Source**: [`src/models/err-invalid-package-target.ts`](src/models/err-invalid-package-target.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.
+
+- `{string}` **`input`** — URL that failed to parse
+- **Returns**: `{ErrInvalidUrl}`
+
+> **Source**: [`src/models/err-invalid-url.ts`](src/models/err-invalid-url.ts)
+
 #### `ERR_METHOD_NOT_IMPLEMENTED(method)`
 
 Thrown when a method is required but not implemented.
@@ -541,7 +553,7 @@ Thrown when an unsupported URL scheme is used in an `import` statement. URL sche
 Creates a Node.js error constructor.
 
 If the given error `message` is a function, constructor arguments are passed to `message`. If the `message` is a string,
-constructor arguments are passed to [`util.format`][11] instead.
+constructor arguments are passed to [`util.format`][14] instead.
 
 - `{ErrorCode}` **`code`** — Node.js error code
 - `{B extends ErrorConstructor}` **`Base`** — Error base class
@@ -561,7 +573,7 @@ Determines the specific type of a value for type-mismatch errors.
 
 ## Types
 
-This package is fully typed with [TypeScript][12]. It exports the following definitions:
+This package is fully typed with [TypeScript][15]. It exports the following definitions:
 
 ### Enums
 
@@ -593,5 +605,8 @@ See [`CONTRIBUTING.md`](CONTRIBUTING.md).
 [8]: https://nodejs.org/api/packages.html#nodejs-packagejson-field-definitions
 [9]: https://nodejs.org/api/packages.html#exports
 [10]: https://nodejs.org/api/packages.html#imports
-[11]: https://nodejs.org/api/util.html#utilformatformat-args
-[12]: https://www.typescriptlang.org
+[11]: https://nodejs.org/api/url.html#the-whatwg-url-api
+[12]: https://nodejs.org/api/url.html#new-urlinput-base
+[13]: https://nodejs.org/api/url.html#urlparseurlstring-parsequerystring-slashesdenotehost
+[14]: https://nodejs.org/api/util.html#utilformatformat-args
+[15]: https://www.typescriptlang.org

src/models/__tests__/err-invalid-url.spec.ts

@@ -0,0 +1,35 @@
+/**
+ * @file Unit Tests - ERR_INVALID_URL
+ * @module errnode/models/tests/unit/ERR_INVALID_URL
+ */
+
+import { ErrorCode } from '#src/enums'
+import type { ErrInvalidUrl } from '#src/interfaces'
+import TestSubject from '../err-invalid-url'
+
+describe('unit:models/ERR_INVALID_URL', () => {
+  let input: string
+  let result: ErrInvalidUrl
+
+  beforeEach(() => {
+    input = 'http://[127.0.0.1\x00c8763]:8000/'
+    result = new TestSubject(input)
+  })
+
+  it('should return TypeError instance', () => {
+    expect(result).to.be.instanceof(TypeError)
+    expect(result).to.have.property('name').equal('TypeError')
+  })
+
+  it('should set #input', () => {
+    expect(result).to.have.property('input').equal(input)
+  })
+
+  it('should set error code', () => {
+    expect(result).to.have.property('code').equal(ErrorCode.ERR_INVALID_URL)
+  })
+
+  it('should set error message', () => {
+    expect(result).to.have.property('message').equal('Invalid URL')
+  })
+})

src/models/err-invalid-url.ts

@@ -0,0 +1,52 @@
+/**
+ * @file Error Models - ERR_INVALID_URL
+ * @module errnode/models/ERR_INVALID_URL
+ * @see https://github.com/nodejs/node/blob/v19.3.0/lib/internal/errors.js#L1381-L1386
+ */
+
+import { ErrorCode } from '#src/enums'
+import type { ErrInvalidUrl } from '#src/interfaces'
+import type { MessageFn, NodeErrorConstructor } from '#src/types'
+import { createNodeError } from '#src/utils'
+
+/**
+ * `ERR_INVALID_URL` model.
+ *
+ * Thrown when an invalid URL is passed to a [WHATWG][1] [`URL` constructor][2]
+ * or [`url.parse()`][3] to be parsed.
+ *
+ * [1]: https://nodejs.org/api/url.html#the-whatwg-url-api
+ * [2]: https://nodejs.org/api/url.html#new-urlinput-base
+ * [3]: https://nodejs.org/api/url.html#urlparseurlstring-parsequerystring-slashesdenotehost
+ *
+ * @see https://nodejs.org/api/errors.html#err_invalid_url
+ *
+ * @class
+ *
+ * @param {string} input - URL that failed to parse
+ * @return {ErrInvalidUrl} `TypeError` instance
+ */
+const ERR_INVALID_URL: NodeErrorConstructor<
+  TypeErrorConstructor,
+  MessageFn<[string]>,
+  ErrInvalidUrl
+> = createNodeError(
+  ErrorCode.ERR_INVALID_URL,
+  TypeError,
+  /**
+   * Creates an [`ERR_INVALID_URL`][1] message.
+   *
+   * [1]: https://nodejs.org/api/errors.html#err_invalid_url
+   *
+   * @this {ErrInvalidUrl}
+   *
+   * @param {string} input - URL that failed to parse
+   * @return {string} Error message
+   */
+  function msg(this: ErrInvalidUrl, input: string): string {
+    this.input = input
+    return 'Invalid URL'
+  }
+)
+
+export default ERR_INVALID_URL

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_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'
 export { default as ERR_MODULE_NOT_FOUND } from './err-module-not-found'