refactor: stringifiable parameters

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

Author: unicornware

.dictionary.txt

@@ -39,6 +39,7 @@ pathe
 pkgs
 preid
 shfmt
+stringifiable
 syscall
 syscodes
 unstub

README.md

@@ -34,6 +34,7 @@ Universal API for creating [Node.js errors][errors]
   - [`NodeErrorConstructor<[T][, Args]>`](#nodeerrorconstructort-args)
   - [`NodeErrorMap`](#nodeerrormap)
   - [`NodeError<[T]>`](#nodeerrort)
+  - [`Stringifiable`](#stringifiable)
   - [`SystemCode`](#systemcode)
   - [`SystemErrorMap`](#systemerrormap)
 - [Contribute](#contribute)
@@ -471,6 +472,15 @@ Node.js error object (TypeScript interface).
 - `toString` (`() => string`)
   — get a string representation of the error
 
+### `Stringifiable`
+
+A value with a `toString` method (TypeScript interface).
+
+#### Properties
+
+- `toString` (`() => string`)
+  — get a string representation of the value
+
 ### `SystemCode`
 
 Union of registered codes that can occur where a system error code is expected (TypeScript type).

src/errors/err-import-assertion-type-failed.ts

@@ -6,7 +6,11 @@
 
 import E from '#e'
 import { codes } from '#src/enums'
-import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+import type {
+  NodeError,
+  NodeErrorConstructor,
+  Stringifiable
+} from '#src/interfaces'
 
 /**
  * `ERR_IMPORT_ASSERTION_TYPE_FAILED` schema.
@@ -22,8 +26,10 @@ interface ErrImportAssertionTypeFailed
 
 /**
  * `ERR_IMPORT_ASSERTION_TYPE_FAILED` message arguments.
+ *
+ * @see {@linkcode Stringifiable}
  */
-type Args = [id: string, type: string]
+type Args = [id: Stringifiable, type: Stringifiable]
 
 /**
  * `ERR_IMPORT_ASSERTION_TYPE_FAILED` constructor.
@@ -40,14 +46,15 @@ interface ErrImportAssertionTypeFailedConstructor
    * Create a new `ERR_IMPORT_ASSERTION_TYPE_FAILED` error.
    *
    * @see {@linkcode ErrImportAssertionTypeFailed}
+   * @see {@linkcode Stringifiable}
    *
-   * @param {string} id
-   *  Id of module that cannot be imported
-   * @param {string} type
+   * @param {Stringifiable} id
+   *  Module id
+   * @param {Stringifiable} type
    *  Invalid import assertion type
    * @return {ErrImportAssertionTypeFailed}
    */
-  new (id: string, type: string): ErrImportAssertionTypeFailed
+  new (id: Stringifiable, type: Stringifiable): ErrImportAssertionTypeFailed
 }
 
 /**

src/errors/err-import-assertion-type-missing.ts

@@ -6,7 +6,11 @@
 
 import E from '#e'
 import { codes } from '#src/enums'
-import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+import type {
+  NodeError,
+  NodeErrorConstructor,
+  Stringifiable
+} from '#src/interfaces'
 
 /**
  * `ERR_IMPORT_ASSERTION_TYPE_MISSING` schema.
@@ -22,8 +26,10 @@ interface ErrImportAssertionTypeMissing
 
 /**
  * `ERR_IMPORT_ASSERTION_TYPE_MISSING` message arguments.
+ *
+ * @see {@linkcode Stringifiable}
  */
-type Args = [id: string, type: string]
+type Args = [id: Stringifiable, type: Stringifiable]
 
 /**
  * `ERR_IMPORT_ASSERTION_TYPE_MISSING` constructor.
@@ -40,14 +46,15 @@ interface ErrImportAssertionTypeMissingConstructor
    * Create a new `ERR_IMPORT_ASSERTION_TYPE_MISSING` error.
    *
    * @see {@linkcode ErrImportAssertionTypeMissing}
+   * @see {@linkcode Stringifiable}
    *
-   * @param {string} id
-   *  Id of module that cannot be imported
-   * @param {string} type
+   * @param {Stringifiable} id
+   *  Module id
+   * @param {Stringifiable} type
    *  Required import assertion type
    * @return {ErrImportAssertionTypeMissing}
    */
-  new (id: string, type: string): ErrImportAssertionTypeMissing
+  new (id: Stringifiable, type: Stringifiable): ErrImportAssertionTypeMissing
 }
 
 /**

src/errors/err-import-assertion-type-unsupported.ts

@@ -23,7 +23,7 @@ interface ErrImportAssertionTypeUnsupported
 /**
  * `ERR_IMPORT_ASSERTION_TYPE_UNSUPPORTED` message arguments.
  */
-type Args = [type: string]
+type Args = [type: unknown]
 
 /**
  * `ERR_IMPORT_ASSERTION_TYPE_UNSUPPORTED` constructor.
@@ -41,11 +41,11 @@ interface ErrImportAssertionTypeUnsupportedConstructor
    *
    * @see {@linkcode ErrImportAssertionTypeUnsupported}
    *
-   * @param {string} type
+   * @param {unknown} type
    *  Unsupported import assertion type
    * @return {ErrImportAssertionTypeUnsupported}
    */
-  new (type: string): ErrImportAssertionTypeUnsupported
+  new (type: unknown): ErrImportAssertionTypeUnsupported
 }
 
 /**

src/errors/err-import-attribute-missing.ts

@@ -6,7 +6,11 @@
 
 import E from '#e'
 import { codes } from '#src/enums'
-import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+import type {
+  NodeError,
+  NodeErrorConstructor,
+  Stringifiable
+} from '#src/interfaces'
 
 /**
  * `ERR_IMPORT_ATTRIBUTE_MISSING` schema.
@@ -22,8 +26,10 @@ interface ErrImportAttributeMissing
 
 /**
  * `ERR_IMPORT_ATTRIBUTE_MISSING` message arguments.
+ *
+ * @see {@linkcode Stringifiable}
  */
-type Args = [id: string, key: string, value: string]
+type Args = [id: Stringifiable, key: Stringifiable, value: Stringifiable]
 
 /**
  * `ERR_IMPORT_ATTRIBUTE_MISSING` constructor.
@@ -40,16 +46,21 @@ interface ErrImportAttributeMissingConstructor
    * Create a new `ERR_IMPORT_ATTRIBUTE_MISSING` error.
    *
    * @see {@linkcode ErrImportAttributeMissing}
+   * @see {@linkcode Stringifiable}
    *
-   * @param {string} id
+   * @param {Stringifiable} id
    *  Module id
-   * @param {string} key
+   * @param {Stringifiable} key
    *  The required import attribute key
-   * @param {string} value
+   * @param {Stringifiable} value
    *  The required import attribute value
    * @return {ErrImportAttributeMissing}
    */
-  new (id: string, key: string, value: string): ErrImportAttributeMissing
+  new (
+    id: Stringifiable,
+    key: Stringifiable,
+    value: Stringifiable
+  ): ErrImportAttributeMissing
 }
 
 /**

src/errors/err-import-attribute-type-incompatible.ts

@@ -6,7 +6,11 @@
 
 import E from '#e'
 import { codes } from '#src/enums'
-import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+import type {
+  NodeError,
+  NodeErrorConstructor,
+  Stringifiable
+} from '#src/interfaces'
 
 /**
  * `ERR_IMPORT_ATTRIBUTE_TYPE_INCOMPATIBLE` schema.
@@ -22,8 +26,10 @@ interface ErrImportAttributeTypeIncompatible
 
 /**
  * `ERR_IMPORT_ATTRIBUTE_TYPE_INCOMPATIBLE` message arguments.
+ *
+ * @see {@linkcode Stringifiable}
  */
-type Args = [id: string, type: string]
+type Args = [id: Stringifiable, type: Stringifiable]
 
 /**
  * `ERR_IMPORT_ATTRIBUTE_TYPE_INCOMPATIBLE` constructor.
@@ -40,14 +46,18 @@ interface ErrImportAttributeTypeIncompatibleConstructor
    * Create a new `ERR_IMPORT_ATTRIBUTE_TYPE_INCOMPATIBLE` error.
    *
    * @see {@linkcode ErrImportAttributeTypeIncompatible}
+   * @see {@linkcode Stringifiable}
    *
-   * @param {string} id
+   * @param {Stringifiable} id
    *  Module id
-   * @param {string} type
+   * @param {Stringifiable} type
    *  Specified type
    * @return {ErrImportAttributeTypeIncompatible}
    */
-  new (id: string, type: string): ErrImportAttributeTypeIncompatible
+  new (
+    id: Stringifiable,
+    type: Stringifiable
+  ): ErrImportAttributeTypeIncompatible
 }
 
 /**

src/errors/err-import-attribute-unsupported.ts

@@ -6,7 +6,11 @@
 
 import E from '#e'
 import { codes } from '#src/enums'
-import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+import type {
+  NodeError,
+  NodeErrorConstructor,
+  Stringifiable
+} from '#src/interfaces'
 
 /**
  * `ERR_IMPORT_ATTRIBUTE_UNSUPPORTED` schema.
@@ -22,8 +26,10 @@ interface ErrImportAttributeUnsupported
 
 /**
  * `ERR_IMPORT_ATTRIBUTE_UNSUPPORTED` message arguments.
+ *
+ * @see {@linkcode Stringifiable}
  */
-type Args = [key: string, value: string]
+type Args = [key: Stringifiable, value: unknown]
 
 /**
  * `ERR_IMPORT_ATTRIBUTE_UNSUPPORTED` constructor.
@@ -40,14 +46,15 @@ interface ErrImportAttributeUnsupportedConstructor
    * Create a new `ERR_IMPORT_ATTRIBUTE_UNSUPPORTED` error.
    *
    * @see {@linkcode ErrImportAttributeUnsupported}
+   * @see {@linkcode Stringifiable}
    *
-   * @param {string} key
+   * @param {Stringifiable} key
    *  Import attribute key
-   * @param {string} value
+   * @param {unknown} value
    *  Import attribute value
    * @return {ErrImportAttributeUnsupported}
    */
-  new (key: string, value: string): ErrImportAttributeUnsupported
+  new (key: Stringifiable, value: unknown): ErrImportAttributeUnsupported
 }
 
 /**

src/errors/err-incompatible-option-pair.ts

@@ -6,7 +6,11 @@
 
 import E from '#e'
 import { codes } from '#src/enums'
-import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+import type {
+  NodeError,
+  NodeErrorConstructor,
+  Stringifiable
+} from '#src/interfaces'
 
 /**
  * `ERR_INCOMPATIBLE_OPTION_PAIR` schema.
@@ -22,8 +26,10 @@ interface ErrIncompatibleOptionPair
 
 /**
  * `ERR_INCOMPATIBLE_OPTION_PAIR` message arguments.
+ *
+ * @see {@linkcode Stringifiable}
  */
-type Args = [option1: string, option2: string]
+type Args = [option1: Stringifiable, option2: Stringifiable]
 
 /**
  * `ERR_INCOMPATIBLE_OPTION_PAIR` constructor.
@@ -40,14 +46,18 @@ interface ErrIncompatibleOptionPairConstructor
    * Create a new `ERR_INCOMPATIBLE_OPTION_PAIR` error.
    *
    * @see {@linkcode ErrIncompatibleOptionPair}
+   * @see {@linkcode Stringifiable}
    *
-   * @param {string} option1
+   * @param {Stringifiable} option1
    *  Option that cannot be used
-   * @param {string} option2
+   * @param {Stringifiable} option2
    *  Option that is incompatible with `option1`
    * @return {ErrIncompatibleOptionPair}
    */
-  new (option1: string, option2: string): ErrIncompatibleOptionPair
+  new (
+    option1: Stringifiable,
+    option2: Stringifiable
+  ): ErrIncompatibleOptionPair
 }
 
 /**

src/errors/err-invalid-file-url-host.ts

@@ -6,7 +6,11 @@
 
 import E from '#e'
 import { codes } from '#src/enums'
-import type { NodeError, NodeErrorConstructor } from '#src/interfaces'
+import type {
+  NodeError,
+  NodeErrorConstructor,
+  Stringifiable
+} from '#src/interfaces'
 
 /**
  * `ERR_INVALID_FILE_URL_HOST` schema.
@@ -22,8 +26,10 @@ interface ErrInvalidFileUrlHost
 
 /**
  * `ERR_INVALID_FILE_URL_HOST` message arguments.
+ *
+ * @see {@linkcode Stringifiable}
  */
-type Args = [platform: string]
+type Args = [platform: Stringifiable]
 
 /**
  * `ERR_INVALID_FILE_URL_HOST` constructor.
@@ -39,12 +45,13 @@ interface ErrInvalidFileUrlHostConstructor
    * Create a new `ERR_INVALID_FILE_URL_HOST` error.
    *
    * @see {@linkcode ErrInvalidFileUrlHost}
+   * @see {@linkcode Stringifiable}
    *
-   * @param {string} platform
+   * @param {Stringifiable} platform
    *  Platform invalid host was encountered on
    * @return {ErrInvalidFileUrlHost}
    */
-  new (platform: string): ErrInvalidFileUrlHost
+  new (platform: Stringifiable): ErrInvalidFileUrlHost
 }
 
 /**