@rzl-zone/utils-js 3.13.1 → 3.14.0-beta.0

package/dist/{index-B1VQ6USF.d.ts → index-jyuOZMX7.d.ts}

@@ -2,22 +2,24 @@
 * ========================================================================
 *  @rzl-zone/utils-js
 * ------------------------------------------------------------------------
-*  Version: `3.13.1`
+*  Version: `3.14.0-beta.0`
 *  Author: `Rizalvin Dwiky <rizalvindwiky@gmail.com>`
 *  Repository: `https://github.com/rzl-zone/rzl-zone/tree/main/packages/utils-js`
 * ========================================================================
 */
 
-import { a as IsNumberOptions, c as GetPreciseTypeOptions, i as ArrayFallback, t as IsPlainObjectResult } from "./isPlainObject-BwTkj3G0.js";
-import { PickStrict, Prettify } from "@rzl-zone/ts-types-plus";
-/** -------------------------------------------------------
+import { M as PickStrict, N as Prettify } from "./index-DZHiYYR7.js";
+import { a as IsNumberOptions, c as GetPreciseTypeOptions, i as ArrayFallback, t as IsPlainObjectResult } from "./isPlainObject-CJvRG4Je.js";
+/** -----------------------------------------------------------------------------
 * * ***Shape of the object passed to custom error message functions.***
-* -------------------------------------------------------
+* ------------------------------------------------------------------------------
 * **This type describes the parameters received when `options.message`
 * is defined as a function in {@link OptionsAssertIs | `OptionsAssertIs`}.**
+*
 * - **Parameter:**
-*    - `currentType` ➔ the actual detected runtime type of the value.
-*    - `validType`   ➔ the required/expected type name that the value must match.
+*      - `currentType` ➔ the actual detected runtime type of the value.
+*      - `validType`   ➔ the required/expected type name that the value must match.
+*
 * @example
 * ```ts
 * const options: OptionsAssertIs = {
@@ -30,16 +32,16 @@ import { PickStrict, Prettify } from "@rzl-zone/ts-types-plus";
 type OptionsMessageFunctionAssertIs = {
   /** ---------------------------------------------------------------------------
   * * ***The actual runtime type of the value being checked.***
-  * ---------------------------------------------------------------------------
+  * ----------------------------------------------------------------------------
   * - ***Example:***
-  *    - `"number"`, `"big-int"`, `"plain-object"`, (depends `formatCase` options).
+  *      - `"number"`, `"big-int"`, `"plain-object"`, (depends-on `formatCase` options).
   */
   currentType: string;
   /** ---------------------------------------------------------------------------
   * * ***The required/expected type that the value must conform to.***
-  * ---------------------------------------------------------------------------
+  * ----------------------------------------------------------------------------
   * - ***Example:***
-  *    - `"boolean"`, `"string"`, `"big-int"`, `"plain-object"`, (will force format to `kebab-case`).
+  *      - `"boolean"`, `"string"`, `"big-int"`, `"plain-object"`, (will force format to `kebab-case`).
   */
   validType: string;
 };
@@ -47,8 +49,8 @@ type OptionsMessageFunctionAssertIs = {
 * * ***Custom error-message type for assertions option {@link OptionsAssertIs | `OptionsAssertIs`}.***
 * -------------------------------------------------------
 * - ***Accepts:***
-*    - A static string message.
-*    - A function receiving `{ currentType, validType }` and returning a string.
+*      - A static string message.
+*      - A function receiving `{ currentType, validType }` and returning a string.
 */
 type OptionsMessageAssertIs = (({
   currentType,
@@ -56,24 +58,26 @@ type OptionsMessageAssertIs = (({
 }: OptionsMessageFunctionAssertIs) => string) | string;
 /** ---------------------------------------------------------------------------
 * * ***Base options for `assertIs*` functions.***
-* ---------------------------------------------------------------------------
+* ----------------------------------------------------------------------------
 */
 type OptionsAssertIs = Prettify<{
-  /** -------------------------------------------------------
+  /** -----------------------------------------------------------------------
   * * ***Custom error message for assertion failures.***
-  * -------------------------------------------------------
+  * ------------------------------------------------------------------------
   * **This option allows overriding the **default error message** when a value
   * does not match the required type.**
+  *
   * - If a **string** is provided:
-  *    - Must be non-empty after trimming.
-  *    - Will be used directly as the error message.
+  *      - Must be non-empty after trimming.
+  *      - Will be used directly as the error message.
   * - If a **function** is provided:
-  *    - Receives an object containing:
-  *      - `currentType` ➔ the detected runtime type of the value (depends `formatCase` options, e.g., `"number"`).
-  *      - `validType`  ➔ the expected type name (with format `kebab-case`, e.g., `"boolean"`, `"big-int"`, `"plain-object"`).
-  *    - **Must** return a **string**:
-  *      - **If** the **returned string is** `empty` or `whitespace`,
-  *        the **default message** will be used instead.
+  *      - Receives an object containing:
+  *          - `currentType` ➔ the detected runtime type of the value (depends-on `formatCase` options, e.g., `"number"`).
+  *          - `validType`  ➔ the expected type name (with format `kebab-case`, e.g., `"boolean"`, `"big-int"`, `"plain-object"`).
+  *      - **Must** return a **string**:
+  *          - **If** the **returned string is** `empty` or `whitespace`,
+  *            the **default message** will be used instead.
+  *
   * @example
   * ```ts
   * // Static message
@@ -88,18 +92,19 @@ type OptionsAssertIs = Prettify<{
   * ```
   */
   message?: OptionsMessageAssertIs;
-  /** -------------------------------------------------------
+  /** -----------------------------------------------------------------------
   * * ***Custom error type for assertion failures.***
-  * -------------------------------------------------------
+  * ------------------------------------------------------------------------
   * **This option allows overriding the default error type** that will be thrown
   * when a value does not match the required type.
   *
   * - **Behavior:**
-  *    - Must be one of the standard JavaScript built-in error types:
-  *      `"Error" | "EvalError" | "RangeError" | "ReferenceError" | "SyntaxError" | "TypeError" | "URIError"`
-  *    - **Default:** `"TypeError"` if not provided or if an invalid value is passed.
-  *    - The assertion function will **always throw a valid built-in error**, ensuring
-  *   fallback to `TypeError` in case of an unknown or incorrect type.
+  *     - Must be one of the standard JavaScript built-in error types:
+  *       `"Error" | "EvalError" | "RangeError" | "ReferenceError" | "SyntaxError" | "TypeError" | "URIError"`.
+  *     - **Default:** `"TypeError"` if not provided or if an invalid value is passed.
+  *     - The assertion function will **always throw a valid built-in error**, ensuring
+  *       fallback to `TypeError` in case of an unknown or incorrect type.
+  *
   * @example
   * ```ts
   * // Valid: Throw a RangeError instead of TypeError
@@ -114,40 +119,44 @@ type OptionsAssertIs = Prettify<{
   */
   errorType?: ErrorType;
 } & PickStrict<GetPreciseTypeOptions, "formatCase" | "useAcronyms">, {
-  recursive: true;
+  recursive: false;
 }>;
 type ErrorType = "Error" | "EvalError" | "RangeError" | "ReferenceError" | "SyntaxError" | "TypeError" | "URIError";
-/** -------------------------------------------------------
+/** ---------------------------------------------------------------------------------
 * * ***Type guard assertion: `assertIsBoolean`.***
-* -------------------------------------------------------
+* ----------------------------------------------------------------------------------
 * **This function is an **assertion function**.**
+*
 * - **Behavior:**
-*    - Validates that the given `value` is a **boolean**.
-*    - After it returns successfully, TypeScript narrows the type of `value` to `boolean`.
-*    - ✅ If `value` is a `boolean` ➔ execution continues normally.
-*    - ❌ If `value` is not a `boolean` ➔ throws a built-in error with either:
-*      - A custom error message (`options.message`), or
-*      - A default message including the actual type.
-* - **⚠️ Error type selection (`options.errorType`):**
-*    - You can override the type of error thrown when validation fails.
-*    - Must be one of the standard JavaScript built-in errors:
-*      - [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) |
-*        [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) |
-*        [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) |
-*        [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) |
-*        [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) |
-*        [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) |
-*        [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError)
-*    - **Default:** `"TypeError"` if not provided or invalid.
+*     - Validates that the given `value` is a **boolean**.
+*     - After it returns successfully, TypeScript narrows the type of `value` to `boolean`.
+*     - If `value` is a `boolean` ➔ execution continues normally.
+*     - If `value` is not a `boolean` ➔ throws a built-in error with either:
+*       - A custom error message (`options.message`), or
+*       - A default message including the actual type.
+* - **Error type selection (`options.errorType`):**
+*     - You can override the type of error thrown when validation fails.
+*     - Must be one of the standard JavaScript built-in errors:
+*       - [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) |
+*         [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) |
+*         [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) |
+*         [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) |
+*         [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) |
+*         [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) |
+*         [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError).
+*     - **Default:** `"TypeError"` if not provided or invalid.
+*
 * @param {*} value - ***The value to validate.***
 * @param {OptionsAssertIs} [options]
 *  ***Optional configuration:***
-*    - `message`: A custom error message (`string` or `function`).
-*    - `errorType`: A custom built-in JavaScript error type to throw.
-*    - `formatCase`: Controls how detected type names are formatted case in error messages.
-*    - `useAcronyms`: Control uppercase preservation of recognized acronyms during formatting.
-* @returns {boolean} Narrows `value` to `boolean` if no error is thrown.
+*     - `message`: A custom error message (`string` or `function`).
+*     - `errorType`: A custom built-in JavaScript error type to throw.
+*     - `formatCase`: Controls how detected type names are formatted case in error messages.
+*     - `useAcronyms`: Control uppercase preservation of recognized acronyms during formatting.
+*
 * @throws [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) | [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) | [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) | [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) | [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) | [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) | [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError) if the value is not a boolean.
+* @returns {boolean} Narrows `value` to `boolean` if no error is thrown.
+*
 * @example
 * ```ts
 * // ✅ Simple usage
@@ -229,40 +238,44 @@ type ErrorType = "Error" | "EvalError" | "RangeError" | "ReferenceError" | "Synt
 * ```
 */
 declare const assertIsBoolean: (value: unknown, options?: OptionsAssertIs) => asserts value is boolean;
-/** -------------------------------------------------------
+/** --------------------------------------------------------------------------------
 * * ***Type guard assertion: `assertIsBigInt`.***
-* -------------------------------------------------------
+* ---------------------------------------------------------------------------------
 * **This function is an **assertion function**.**
+*
 * - **Behavior:**
-*    - Validates that the given `value` is a **bigint**.
-*    - After it returns successfully, TypeScript narrows the type of `value` to `bigint`.
-*    - ✅ If `value` is a `bigint` ➔ execution continues normally.
-*    - ❌ If `value` is not a `bigint` ➔ throws a built-in error with either:
-*      - A custom error message (`options.message`), or
-*      - A default message including the actual type.
-*  - **ℹ️ Note:**
-*    - A `bigint` refers strictly to the JavaScript `bigint` primitive type (e.g., `123n`, `0n`, `-999999999999999999999n`).
-*    - This excludes `BigInt` objects created with `Object(BigInt(123))`.
-*  - **⚠️ Error type selection (`options.errorType`):**
-*    - You can override the type of error thrown when validation fails.
-*    - Must be one of the standard JavaScript built-in errors:
-*      - [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) |
-*        [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) |
-*        [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) |
-*        [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) |
-*        [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) |
-*        [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) |
-*        [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError)
-*    - **Default:** `"TypeError"` if not provided or invalid.
+*     - Validates that the given `value` is a **bigint**.
+*     - After it returns successfully, TypeScript narrows the type of `value` to `bigint`.
+*     - If `value` is a `bigint` ➔ execution continues normally.
+*     - If `value` is not a `bigint` ➔ throws a built-in error with either:
+*       - A custom error message (`options.message`), or
+*       - A default message including the actual type.
+* - **Note:**
+*     - A `bigint` refers strictly to the JavaScript `bigint` primitive type (e.g., `123n`, `0n`, `-999999999999999999999n`).
+*     - This excludes `BigInt` objects created with `Object(BigInt(123))`.
+* - **Error type selection (`options.errorType`):**
+*     - You can override the type of error thrown when validation fails.
+*     - Must be one of the standard JavaScript built-in errors:
+*       - [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) |
+*         [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) |
+*         [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) |
+*         [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) |
+*         [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) |
+*         [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) |
+*         [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError).
+*     - **Default:** `"TypeError"` if not provided or invalid.
+*
 * @param {*} value - ***The value to validate.***
 * @param {OptionsAssertIs} [options]
 *  ***Optional configuration:***
-*    - `message`: A custom error message (`string` or `function`).
-*    - `errorType`: Built-in JavaScript error type to throw on failure (default `"TypeError"`).
-*    - `formatCase`: Controls how detected type names are formatted case in error messages.
-*    - `useAcronyms`: Control uppercase preservation of recognized acronyms during formatting.
-* @returns {boolean} Narrows `value` to `bigint` if no error is thrown.
+*     - `message`: A custom error message (`string` or `function`).
+*     - `errorType`: Built-in JavaScript error type to throw on failure (default `"TypeError"`).
+*     - `formatCase`: Controls how detected type names are formatted case in error messages.
+*     - `useAcronyms`: Control uppercase preservation of recognized acronyms during formatting.
+*
 * @throws [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) | [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) | [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) | [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) | [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) | [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) | [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError) if the value is not a bigint.
+* @returns {boolean} Narrows `value` to `bigint` if no error is thrown.
+*
 * @example
 * ```ts
 * // ✅ Simple usage
@@ -341,42 +354,46 @@ declare const assertIsBoolean: (value: unknown, options?: OptionsAssertIs) => as
 */
 declare const assertIsBigInt: (value: unknown, options?: OptionsAssertIs) => asserts value is bigint;
 type OptionsAssertIsNumber = OptionsAssertIs & IsNumberOptions;
-/** -------------------------------------------------------
+/** --------------------------------------------------------------------------------
 * * ***Type guard assertion: `assertIsNumber`.***
-* -------------------------------------------------------
+* ---------------------------------------------------------------------------------
 * **This function is an **assertion function**.**
+*
 * - **Behavior:**
-*    - Validates that the given `value` is a **number**.
-*    - After it returns successfully, TypeScript narrows the type of `value` to `number`.
-*    - ✅ If `value` is a `number` ➔ execution continues normally.
-*    - ❌ If `value` is not a `number` ➔ throws a built-in error with either:
-*      - A custom error message (`options.message`), or
-*      - A default message including the actual type.
-* - **ℹ️ Note:**
-*    - A `number` refers strictly to the JavaScript `number` primitive type (e.g., `42`, `3.14`, `-1`, `0`).
-*    - This excludes `Number` objects created with `new Number(123)`.
-*    - By default, `NaN` is **not considered** valid, you can allow it with `{ includeNaN: true }`.
-* - **⚠️ Error type selection (`options.errorType`):**
-*    - You can override the type of error thrown when validation fails.
-*    - Must be one of the standard JavaScript built-in errors:
-*      - [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) |
-*        [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) |
-*        [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) |
-*        [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) |
-*        [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) |
-*        [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) |
-*        [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError)
-*    - **Default:** `"TypeError"` if not provided or invalid.
+*     - Validates that the given `value` is a **number**.
+*     - After it returns successfully, TypeScript narrows the type of `value` to `number`.
+*     - If `value` is a `number` ➔ execution continues normally.
+*     - If `value` is not a `number` ➔ throws a built-in error with either:
+*       - A custom error message (`options.message`), or
+*       - A default message including the actual type.
+* - **Note:**
+*     - A `number` refers strictly to the JavaScript `number` primitive type (e.g., `42`, `3.14`, `-1`, `0`).
+*     - This excludes `Number` objects created with `new Number(123)`.
+*     - By default, `NaN` is **not considered** valid, you can allow it with `{ includeNaN: true }`.
+* - **Error type selection (`options.errorType`):**
+*     - You can override the type of error thrown when validation fails.
+*     - Must be one of the standard JavaScript built-in errors:
+*       - [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) |
+*         [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) |
+*         [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) |
+*         [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) |
+*         [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) |
+*         [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) |
+*         [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError).
+*     - **Default:** `"TypeError"` if not provided or invalid.
+*
 * @param {*} value - ***The value to validate.***
 * @param {OptionsAssertIsNumber} [options]
 *  ***Optional configuration:***
-*    - `message`: A custom error message (`string` or `function`).
-*    - `errorType`: Built-in JavaScript error type to throw on failure (default `"TypeError"`).
-*    - `formatCase`: Controls how detected type names are formatted case in error messages.
-*    - `useAcronyms`: Control uppercase preservation of recognized acronyms during formatting.
-*    - `includeNaN`: Whether to treat `NaN` as valid.
-* @returns {boolean} Narrows `value` to `number` if no error is thrown.
+*     - `message`: A custom error message (`string` or `function`).
+*     - `errorType`: Built-in JavaScript error type to throw on failure (default `"TypeError"`).
+*     - `formatCase`: Controls how detected type names are formatted case in error messages.
+*     - `useAcronyms`: Control uppercase preservation of recognized acronyms during formatting.
+*     - `includeNaN`: Whether to treat `NaN` as valid.
+*
 * @throws [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) | [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) | [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) | [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) | [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) | [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) | [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError) if the value is not a number (or is `NaN` when `includeNaN` is `false`).
+* @returns {boolean} Narrows `value` to `number` if no error is thrown.
+*
 * @example
 * ```ts
 * // ✅ Simple usage
@@ -464,38 +481,42 @@ type OptionsAssertIsNumber = OptionsAssertIs & IsNumberOptions;
 * ```
 */
 declare const assertIsNumber: (value: unknown, options?: OptionsAssertIsNumber) => asserts value is number;
-/** -------------------------------------------------------
+/** --------------------------------------------------------------------------------
 * * ***Type guard assertion: `assertIsArray`.***
-* -------------------------------------------------------
+* ---------------------------------------------------------------------------------
 * **This function is an **assertion function**.**
+*
 * - **Behavior:**
-*    - Validates that the given `value` is an **array**.
-*    - After it returns successfully, TypeScript narrows the type of `value` to `array` **(generic support)**.
-*    - ✅ If `value` is an `array` ➔ execution continues normally.
-*    - ❌ If `value` is not an `array` ➔ throws a built-in error with either:
-*      - A custom error message (`options.message`), or
-*      - A default message including the actual type.
-* - **⚠️ Error type selection (`options.errorType`):**
-*    - You can override the type of error thrown when validation fails.
-*    - Must be one of the standard JavaScript built-in errors:
-*      - [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) |
-*        [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) |
-*        [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) |
-*        [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) |
-*        [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) |
-*        [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) |
-*        [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError)
-*    - **Default:** `"TypeError"` if not provided or invalid.
+*     - Validates that the given `value` is an **array**.
+*     - After it returns successfully, TypeScript narrows the type of `value` to `array` **(generic support)**.
+*     - If `value` is an `array` ➔ execution continues normally.
+*     - If `value` is not an `array` ➔ throws a built-in error with either:
+*       - A custom error message (`options.message`), or
+*       - A default message including the actual type.
+* - **Error type selection (`options.errorType`):**
+*     - You can override the type of error thrown when validation fails.
+*     - Must be one of the standard JavaScript built-in errors:
+*       - [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) |
+*         [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) |
+*         [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) |
+*         [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) |
+*         [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) |
+*         [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) |
+*         [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError).
+*     - **Default:** `"TypeError"` if not provided or invalid.
+*
 * @template T - The input type being asserted.
 * @param {*} value - ***The value to validate.***
 * @param {OptionsAssertIs} [options]
 *  ***Optional configuration:***
-*    - `message`: A custom error message (`string` or `function`).
-*    - `errorType`: Built-in JavaScript error type to throw on failure (default `"TypeError"`).
-*    - `formatCase`: Controls how detected type names are formatted case in error messages.
-*    - `useAcronyms`: Control uppercase preservation of recognized acronyms during formatting.
-* @returns {boolean} Narrows `value` to an `array` **(generic support)** if no error is thrown.
+*     - `message`: A custom error message (`string` or `function`).
+*     - `errorType`: Built-in JavaScript error type to throw on failure (default `"TypeError"`).
+*     - `formatCase`: Controls how detected type names are formatted case in error messages.
+*     - `useAcronyms`: Control uppercase preservation of recognized acronyms during formatting.
+*
 * @throws [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) | [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) | [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) | [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) | [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) | [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) | [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError) if the value is not an array.
+* @returns {boolean} Narrows `value` to an `array` **(generic support)** if no error is thrown.
+*
 * @example
 * ```ts
 * // ✅ Simple usage
@@ -578,52 +599,56 @@ declare const assertIsNumber: (value: unknown, options?: OptionsAssertIsNumber)
 declare function assertIsArray(value: [], options?: OptionsAssertIs): asserts value is [];
 declare function assertIsArray<T>(value: T, options?: OptionsAssertIs): asserts value is ArrayFallback<T>;
 declare function assertIsArray(value: unknown, options?: OptionsAssertIs): asserts value is unknown[];
-/** -------------------------------------------------------
+/** --------------------------------------------------------------------------------
 * * ***Type guard assertion: `assertIsPlainObject`.***
-* -------------------------------------------------------
+* ---------------------------------------------------------------------------------
 * **This function is an **assertion function**.**
+*
 * - **Behavior:**
-*    - Validates that the given `value` is a **plain-object**.
-*    - After it returns successfully, TypeScript narrows the type of `value` to `plain-object` **(generic support)**.
-*    - ✅ If `value` is a `plain-object` ➔ execution continues normally.
-*    - ❌ If `value` is not a `plain-object` ➔ throws a built-in error with either:
-*      - A custom error message (`options.message`), or
-*      - A default message including the actual type.
+*     - Validates that the given `value` is a **plain-object**.
+*     - After it returns successfully, TypeScript narrows the type of `value` to `plain-object` **(generic support)**.
+*     - If `value` is a `plain-object` ➔ execution continues normally.
+*     - If `value` is not a `plain-object` ➔ throws a built-in error with either:
+*       - A custom error message (`options.message`), or
+*       - A default message including the actual type.
 * - **A valid `plain object` is:**
-*    - Created by the `Object` constructor, or
-*    - Has a `[[Prototype]]` of `null` (e.g. `Object.create(null)`).
-*     - **✅ Returns `undefined` (valid) for:**
-*         - Empty object literals: `{}`
-*         - Objects with null prototype: `Object.create(null)`
-*     - **❌ Returns `throws` for:**
-*         - Arrays (`[]`, `new Array()`)
-*         - Functions (regular, arrow, or class constructors)
-*         - Built-in objects: `Date`, `RegExp`, `Error`, `Map`, `Set`, `WeakMap`, `WeakSet`
-*         - Boxed primitives: `new String()`, `new Number()`, `new Boolean()`
-*         - `null` or `undefined`
-*         - Symbols
-*         - Class instances
-* - **⚠️ Error type selection (`options.errorType`):**
-*    - You can override the type of error thrown when validation fails.
-*    - Must be one of the standard JavaScript built-in errors:
-*      - [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) |
-*        [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) |
-*        [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) |
-*        [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) |
-*        [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) |
-*        [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) |
-*        [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError)
-*    - **Default:** `"TypeError"` if not provided or invalid.
+*     - Created by the `Object` constructor, or
+*     - Has a `[[Prototype]]` of `null` (e.g. `Object.create(null)`).
+*      - **Returns `undefined` (valid) for:**
+*          - Empty object literals: `{}`
+*          - Objects with null prototype: `Object.create(null)`
+*      - **Returns `throws` for:**
+*          - Arrays (`[]`, `new Array()`)
+*          - Functions (regular, arrow, or class constructors)
+*          - Built-in objects: `Date`, `RegExp`, `Error`, `Map`, `Set`, `WeakMap`, `WeakSet`
+*          - Boxed primitives: `new String()`, `new Number()`, `new Boolean()`
+*          - `null` or `undefined`
+*          - Symbols
+*          - Class instances
+* - **Error type selection (`options.errorType`):**
+*     - You can override the type of error thrown when validation fails.
+*     - Must be one of the standard JavaScript built-in errors:
+*       - [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) |
+*         [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) |
+*         [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) |
+*         [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) |
+*         [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) |
+*         [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) |
+*         [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError).
+*     - **Default:** `"TypeError"` if not provided or invalid.
+*
 * @template T - The input type being asserted.
 * @param {*} value - ***The value to validate.***
 * @param {OptionsAssertIs} [options]
 *  ***Optional configuration:***
-*    - `message`: A custom error message (`string` or `function`).
-*    - `errorType`: Built-in JavaScript error type to throw on failure (default `"TypeError"`).
-*    - `formatCase`: Controls how detected type names are formatted case in error messages.
-*    - `useAcronyms`: Control uppercase preservation of recognized acronyms during formatting.
-* @returns {boolean} Narrows `value` to a `plain-object` **(generic support)** if no error is thrown.
+*     - `message`: A custom error message (`string` or `function`).
+*     - `errorType`: Built-in JavaScript error type to throw on failure (default `"TypeError"`).
+*     - `formatCase`: Controls how detected type names are formatted case in error messages.
+*     - `useAcronyms`: Control uppercase preservation of recognized acronyms during formatting.
+*
 * @throws [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) | [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) | [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) | [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) | [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) | [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) | [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError) if `value` is not a plain-object.
+* @returns {boolean} Narrows `value` to a `plain-object` **(generic support)** if no error is thrown.
+*
 * @example
 * ```ts
 * // ✅ Simple usage
@@ -703,40 +728,44 @@ declare function assertIsArray(value: unknown, options?: OptionsAssertIs): asser
 * ```
 */
 declare function assertIsPlainObject<T>(value: T, options?: OptionsAssertIs): asserts value is IsPlainObjectResult<T>;
-/** -------------------------------------------------------
+/** --------------------------------------------------------------------------------
 * * ***Type guard assertion: `assertIsString`.***
-* -------------------------------------------------------
+* ---------------------------------------------------------------------------------
 * **This function is an **assertion function**.**
+*
 * - **Behavior:**
-*    - Validates that the given `value` is a **primitive-string**.
-*    - After it returns successfully, TypeScript narrows the type of `value` to `primitive-string`.
-*    - ✅ If `value` is a `primitive-string` ➔ execution continues normally.
-*    - ❌ If `value` is not a `primitive-string` ➔ throws a built-in error with either:
-*      - A custom error message (`options.message`), or
-*      - A default message including the actual type.
-* - **ℹ️ Note:**
-*    - A "string" refers strictly to a JavaScript `primitive-string` type (e.g., `"hello"`, `""`, `"123"`).
-*    - This function excludes `String` objects created with `new String()`.
-* - **⚠️ Error type selection (`options.errorType`):**
-*    - You can override the type of error thrown when validation fails.
-*    - Must be one of the standard JavaScript built-in errors:
-*      - [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) |
-*        [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) |
-*        [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) |
-*        [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) |
-*        [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) |
-*        [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) |
-*        [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError)
-*    - **Default:** `"TypeError"` if not provided or invalid.
+*     - Validates that the given `value` is a **primitive-string**.
+*     - After it returns successfully, TypeScript narrows the type of `value` to `primitive-string`.
+*     - If `value` is a `primitive-string` ➔ execution continues normally.
+*     - If `value` is not a `primitive-string` ➔ throws a built-in error with either:
+*       - A custom error message (`options.message`), or
+*       - A default message including the actual type.
+* - **Note:**
+*     - A "string" refers strictly to a JavaScript `primitive-string` type (e.g., `"hello"`, `""`, `"123"`).
+*     - This function excludes `String` objects created with `new String()`.
+* - **Error type selection (`options.errorType`):**
+*     - You can override the type of error thrown when validation fails.
+*     - Must be one of the standard JavaScript built-in errors:
+*       - [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) |
+*         [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) |
+*         [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) |
+*         [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) |
+*         [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) |
+*         [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) |
+*         [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError).
+*     - **Default:** `"TypeError"` if not provided or invalid.
+*
 * @param {*} value - ***The value to validate.***
 * @param {OptionsAssertIs} [options]
 *  ***Optional configuration:***
-*    - `message`: A custom error message (`string` or `function`).
-*    - `errorType`: Built-in JavaScript error type to throw on failure (default `"TypeError"`).
-*    - `formatCase`: Controls how detected type names are formatted case in error messages.
-*    - `useAcronyms`: Control uppercase preservation of recognized acronyms during formatting.
-* @returns {boolean} Narrows `value` to `string` if no error is thrown.
+*     - `message`: A custom error message (`string` or `function`).
+*     - `errorType`: Built-in JavaScript error type to throw on failure (default `"TypeError"`).
+*     - `formatCase`: Controls how detected type names are formatted case in error messages.
+*     - `useAcronyms`: Control uppercase preservation of recognized acronyms during formatting.
+*
 * @throws [`TypeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypeError) | [`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) | [`EvalError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/EvalError) | [`RangeError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RangeError) | [`ReferenceError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ReferenceError) | [`SyntaxError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SyntaxError) | [`URIError`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/URIError) if the value is not a primitive string.
+* @returns {boolean} Narrows `value` to `string` if no error is thrown.
+*
 * @example
 * ```ts
 * // ✅ Simple usage