@rzl-zone/utils-js 3.2.5-beta.0 → 3.3.0

package/dist/{string-XA-til3C.d.ts → string-B1jlOnws.d.ts}

@@ -1,16 +1,14 @@
-import{I as If}from'./if-CvT4R7Kh.js';import{I as IsNever}from'./never-BfayMBF9.js';
+import{I as If}from'./if-ChM35c_q.js';import{I as IsNever}from'./never-D89PbPh5.js';
 /** -------------------------------------------------------
- * * ***IfNot.***
+ * * ***Utility Type: `IfNot`.***
  * -------------------------------------------------------
- *
- * Conditional: returns the second argument if the first argument is `false`, otherwise returns the third argument.
+ * - **Conditional:**
+ *    - Returns the second argument if the first argument is `false`, otherwise returns the third argument.
  * - Defaults: `IfTrue = true`, `IfFalse = false`.
- *
  * @template Condition - The boolean condition to check.
- * @template IfTrue - The branch type if condition is `false`. (default: `true`)
- * @template IfFalse - The branch type if condition is `true`. (default: `false`)
- *
- * ### Examples
+ * @template IfTrue - The branch type if condition is `false`. (default: `true`).
+ * @template IfFalse - The branch type if condition is `true`. (default: `false`).
+ * @example
  * ```ts
  * type A = IfNot<false, "valid">;
  * // ➔ "valid"
@@ -20,144 +18,117 @@ import{I as If}from'./if-CvT4R7Kh.js';import{I as IsNever}from'./never-BfayMBF9.
  */
 type IfNot<Condition,IfTrue=true,IfFalse=false>=If<Condition,IfFalse,IfTrue>;
 /** -------------------------------------------------------
- * * ***WordSeparator.***
+ * * ***Utility Type: `WordSeparator`.***
  * -------------------------------------------------------
- * A type-level utility that defines all valid ***word separators***.
+ * **A type-level utility that defines all valid ***word separators***.**
  * - Can be a space `" "`, a dash `"-"`, or an underscore `"_"`.
- *
  * @example
- * ```ts
  * type A = WordSeparator; // ➔ " " | "-" | "_"
- * ```
  */
 type WordSeparator=" "|"-"|"_";
 /** --------------------------------------------------
- * * ***Whitespace.***
+ * * ***Utility Type: `Whitespace`.***
  * --------------------------------------------------
- * Represents common whitespace characters.
- *
- * ✅ Used as the default trimming characters in string utility types.
- *
+ * **Represents common whitespace characters.**
+ * - ✅ Used as the default trimming characters in string utility types.
  * @example
- * type W = Whitespace;
- * // ➔ " " | "\t" | "\r" | "\n"
+ * type W = Whitespace; // ➔ " " | "\t" | "\r" | "\n"
  */
 type Whitespace=" "|"\t"|"\r"|"\n";
-/** **Helper Internal.** */
+/** **Helper Type Internal.** */
 type SafeKeyTrimming<T>=Exclude<T,symbol>;
 /** --------------------------------------------------
- * * ***TrimLeft.***
+ * * ***Utility Type: `TrimLeft`.***
  * --------------------------------------------------
- * Recursively trims specified characters (default: **{@link Whitespace}**)
- * from the **start (left)** of a string.
- *
+ * **Recursively trims specified characters (default: **{@link Whitespace | `Whitespace`}**) from the **start (left)** of a string.**
  * @template Text - The string to trim.
  * @template Chars - The characters to remove (default: `Whitespace`).
- *
  * @example
  * type T1 = TrimLeft<"\n  hello", " " | "\n">;
  * // ➔ "hello"
- *
  * type T2 = TrimLeft<"  world">;
  * // ➔ "world"
- *
  * type T3 = TrimLeft<"  world ">;
  * // ➔ "world "
  */
 type TrimLeft<Text extends PropertyKey,Chars extends PropertyKey=Whitespace>=Text extends`${SafeKeyTrimming<Chars>}${infer Rest}`?TrimLeft<Rest,Chars>:Text;
 /** --------------------------------------------------
- * * ***TrimRight.***
+ * * ***Utility Type: `TrimRight`.***
  * --------------------------------------------------
- * Recursively trims specified characters (default: **{@link Whitespace}**)
- * from the **end (right)** of a string.
- *
+ * **Recursively trims specified characters (default: **{@link Whitespace | `Whitespace`}**) from the **end (right)** of a string.**
  * @template Text - The string to trim.
  * @template Chars - The characters to remove (default: `Whitespace`).
- *
  * @example
  * type T1 = TrimRight<"hello  \t", " " | "\t">;
  * // ➔ "hello"
- *
  * type T2 = TrimRight<"world  ">;
  * // ➔ "world"
- *
  * type T2 = TrimRight<" world  ">;
  * // ➔ " world"
  */
 type TrimRight<Text extends PropertyKey,Chars extends PropertyKey=Whitespace>=Text extends`${infer Rest}${SafeKeyTrimming<Chars>}`?TrimRight<Rest,Chars>:Text;
 /** --------------------------------------------------
- * * ***Trim.***
+ * * ***Utility Type: `Trim`.***
  * --------------------------------------------------
- * Trims specified characters (default: **{@link Whitespace}**)
- * from **both the start and end** of a string.
- *
- * @template Text - The string to trim.
+ * **Trims specified characters (default: **{@link Whitespace | `Whitespace`}**)
+ * from **both the start and end** of a string.**
  * @template Chars - The characters to remove (default: `Whitespace`).
- *
  * @example
  * type T1 = Trim<"  hello  ", " ">;
  * // ➔ "hello"
- *
  * type T2 = Trim<"\n  world \t">;
  * // ➔ "world"
  */
 type Trim<Text extends PropertyKey,Chars extends PropertyKey=Whitespace>=TrimRight<TrimLeft<Text,Chars>,Chars>;
 /** -------------------------------------------------------
- * * ***TrimsLower***
+ * * ***Utility Type: `TrimsLower`.***
  * -------------------------------------------------------
- * Trims leading & trailing whitespace from a string and
- * converts it to **lowercase**.
- *
- * Utilizes **{@link Trim}** to remove whitespace and **{@link Lowercase}** to convert the string to lowercase.
- *
+ * **Trims leading & trailing whitespace from a string and
+ * converts it to **lowercase**.**
+ * @description
+ * Utilizes **{@link Trim | `Trim`}** to remove whitespace and
+ * **{@link Lowercase | `Lowercase`}** to convert the string to lowercase.
  * @template S - The input string to transform.
- *
  * @example
  * ```ts
  * type T1 = TrimsLower<"  HeLLo \n">;
  * // ➔ "hello"
- *
  * type T2 = TrimsLower<"  WoRLD  ">;
  * // ➔ "world"
  * ```
  */
 type TrimsLower<S extends string>=Lowercase<Trim<S>>;
 /** -------------------------------------------------------
- * * ***TrimsUpper***
+ * * ***Utility Type: `TrimsUpper`.***
  * -------------------------------------------------------
- * Trims leading & trailing whitespace from a string and
- * converts it to **uppercase**.
- *
- * Utilizes **{@link Trim}** to remove whitespace and **{@link Uppercase}** to convert the string to uppercase.
- *
+ * **Trims leading & trailing whitespace from a string and
+ * converts it to **uppercase**.**
+ * @description
+ * Utilizes **{@link Trim | `Trim`}** to remove whitespace and
+ * **{@link Uppercase | `Uppercase`}** to convert the string to uppercase.
  * @template S - The input string to transform.
- *
  * @example
  * ```ts
  * type T1 = TrimsUpper<"  HeLLo \n">;
  * // ➔ "HELLO"
- *
  * type T2 = TrimsUpper<"  WoRLD  ">;
  * // ➔ "WORLD"
  * ```
  */
 type TrimsUpper<S extends string>=Uppercase<Trim<S>>;
 /** -------------------------------------------------------
- * * ***AnyString.***
+ * * ***Utility Type: `AnyString`.***
  * -------------------------------------------------------
- *
- * A utility type that represents **any string value** while
- * preventing unwanted widening of string literals to `string`.
- *
- * 🔹 This is achieved by intersecting `string` with `{}`,
+ * **A utility type that represents **any string value** while
+ * preventing unwanted widening of string literals to `string`.**
+ * @description
+ * This is achieved by intersecting `string` with `{}`,
  * ensuring that the type remains assignable to `string`
  * but is treated as a unique type in generic constraints.
- *
- * 📌 Useful in scenarios where:
- * - You want to accept **any string**, but still preserve
- *   literal types in inference.
- * - You need stricter typing than just `string`.
- *
+ * - **Useful in scenarios where:**
+ *    - You want to accept **any string**, but still preserve
+ *      literal types in inference.
+ *    - You need stricter typing than just `string`.
  * @example
  * ```ts
  * declare function acceptsAnyString<T extends AnyString>(value: T): T;
@@ -173,19 +144,17 @@ type TrimsUpper<S extends string>=Uppercase<Trim<S>>;
  */
 type AnyString={}& string;
 /** -------------------------------------------------------
- * * ***EmptyString.***
+ * * ***Utility Type: `EmptyString`.***
  * -------------------------------------------------------
- * Returns the type `T` only if it is the empty string `""`.
- * Optionally trims whitespace before checking.
- *
- * Behavior:
- * - If `WithTrim` is `true` (default), trims `T` before checking.
- * - If `T` is the general `string` type, returns `never`.
- * - If `T` is empty (after optional trimming), returns `T` or `Trim<T>`.
- *
+ * - **Conditional type:**
+ *    - Returns the type `T` only if it is the empty string `""`.
+ *    - Optionally trims whitespace before checking.
+ * - **Behavior:**
+ *    - If `WithTrim` is `true` (default), trims `T` before checking.
+ *    - If `T` is the general `string` type, returns `never`.
+ *    - If `T` is empty (after optional trimming), returns `T` or `Trim<T>`.
  * @template T - The string type to check.
  * @template WithTrim - Whether to trim whitespace before checking (default `true`).
- *
  * @example
  * ```ts
  * // Basic empty string
@@ -209,19 +178,17 @@ type AnyString={}& string;
  */
 type EmptyString<T extends string,WithTrim extends boolean=true>=""extends(WithTrim extends true?Trim<T>:T)?string extends(WithTrim extends true?Trim<T>:T)?never:WithTrim extends true?Trim<T>:T:never;
 /** -------------------------------------------------------
- * * ***NonEmptyString.***
+ * * ***Utility Type: `NonEmptyString`.***
  * -------------------------------------------------------
- * Returns the type `T` only if it is a non-empty string.
- * Optionally trims whitespace before checking.
- *
- * Behavior:
- * - If `WithTrim` is `true` (default), trims `T` before checking.
- * - If `T` is the general `string` type, returns `string`.
- * - If `T` is empty (after optional trimming), returns `never`.
- *
+ * - **Conditional type:**
+ *    - Returns the type `T` only if it is a non-empty string.
+ *    - Optionally trims whitespace before checking.
+ * - **Behavior:**
+ *    - If `WithTrim` is `true` (default), trims `T` before checking.
+ *    - If `T` is the general `string` type, returns `string`.
+ *    - If `T` is empty (after optional trimming), returns `never`.
  * @template T - The string type to check.
  * @template WithTrim - Whether to trim whitespace before checking (default `true`).
- *
  * @example
  * ```ts
  * // Non-empty string
@@ -240,19 +207,17 @@ type EmptyString<T extends string,WithTrim extends boolean=true>=""extends(WithT
  */
 type NonEmptyString<T extends string,WithTrim extends boolean=true>=string extends T?string:If<IsNever<EmptyString<T,WithTrim>>,WithTrim extends true?Trim<T>:T,never>;
 /** -------------------------------------------------------
- * * ***IsEmptyString.***
+ * * ***Utility Type: `IsEmptyString`.***
  * -------------------------------------------------------
- * Returns `true` if `T` is exactly the empty string `""`.
- * Optionally trims whitespace before checking.
- *
- * Behavior:
- * - If `WithTrim` is `true` (default), trims `T` before checking.
- * - If `T` is empty after optional trimming, returns `true`.
- * - Otherwise, returns `false`.
- *
+ * - **Conditional type:**
+ *    - Returns `true` if `T` is exactly the empty string `""`.
+ *    - Optionally trims whitespace before checking.
+ * - **Behavior:**
+ *    - If `WithTrim` is `true` (default), trims `T` before checking.
+ *    - If `T` is empty after optional trimming, returns `true`.
+ *    - Otherwise, returns `false`.
  * @template T - The string type to check.
  * @template WithTrim - Whether to trim whitespace before checking (default `true`).
- *
  * @example
  * ```ts
  * type Case1 = IsEmptyString<"">;
@@ -267,19 +232,17 @@ type NonEmptyString<T extends string,WithTrim extends boolean=true>=string exten
  */
 type IsEmptyString<T extends string,WithTrim extends boolean=true>=IfNot<IsNever<EmptyString<T,WithTrim>>>;
 /** -------------------------------------------------------
- * * ***IsNonEmptyString.***
+ * * ***Utility Type: `IsNonEmptyString`.***
  * -------------------------------------------------------
- * Returns `true` if `T` is a non-empty string.
- * Optionally trims whitespace before checking.
- *
- * Behavior:
- * - If `WithTrim` is `true` (default), trims `T` before checking.
- * - Returns `true` if `T` is non-empty after optional trimming.
- * - Returns `false` if `T` is empty (after trimming if `WithTrim=true`).
- *
+ * - **Conditional type:**
+ *    - Returns `true` if `T` is a non-empty string.
+ *    - Optionally trims whitespace before checking.
+ * - **Behavior:**
+ *    - If `WithTrim` is `true` (default), trims `T` before checking.
+ *    - Returns `true` if `T` is non-empty after optional trimming.
+ *    - Returns `false` if `T` is empty (after trimming if `WithTrim=true`).
  * @template T - The string type to check.
  * @template WithTrim - Whether to trim whitespace before checking (default `true`).
- *
  * @example
  * ```ts
  * type Case1 = IsNonEmptyString<"abc">;
@@ -294,16 +257,15 @@ type IsEmptyString<T extends string,WithTrim extends boolean=true>=IfNot<IsNever
  */
 type IsNonEmptyString<T extends string,WithTrim extends boolean=true>=IfNot<IsNever<NonEmptyString<T,WithTrim>>>;
 /** -------------------------------------------------------
- * * ***IfEmptyString.***
+ * * ***Utility Type: `IfEmptyString`.***
  * -------------------------------------------------------
- * Conditional type: returns `IfTrue` if `T` is an empty string `""`,
- * otherwise returns `IfFalse`. Optionally trims whitespace before checking.
- *
+ * - **Conditional type:**
+ *    - Returns `IfTrue` if `T` is an empty string `""`, otherwise returns `IfFalse`.
+ *    - Optionally trims whitespace before checking.
  * @template T - The string type to check.
  * @template IfTrue - Type returned if `T` is empty (default `true`).
  * @template IfFalse - Type returned if `T` is not empty (default `false`).
  * @template WithTrim - Whether to trim whitespace before checking (default `true`).
- *
  * @example
  * ```ts
  * type Case1 = IfEmptyString<"">;
@@ -322,16 +284,15 @@ type IsNonEmptyString<T extends string,WithTrim extends boolean=true>=IfNot<IsNe
  */
 type IfEmptyString<T extends string,IfTrue=true,IfFalse=false,WithTrim extends boolean=true>=IfNot<IsNever<EmptyString<T,WithTrim>>,IfTrue,IfFalse>;
 /** -------------------------------------------------------
- * * ***IfNonEmptyString.***
+ * * ***Utility Type: `IfNonEmptyString`.***
  * -------------------------------------------------------
- * Conditional type: returns `IfTrue` if `T` is a non-empty string,
- * otherwise returns `IfFalse`. Optionally trims whitespace before checking.
- *
+ * - **Conditional type:**
+ *    - Returns `IfTrue` if `T` is a non-empty string, otherwise returns `IfFalse`.
+ *    - Optionally trims whitespace before checking.
  * @template T - The string type to check.
  * @template IfTrue - Type returned if `T` is non-empty (default `true`).
  * @template IfFalse - Type returned if `T` is empty (default `false`).
  * @template WithTrim - Whether to trim whitespace before checking (default `true`).
- *
  * @example
  * ```ts
  * type Case1 = IfNonEmptyString<"abc">;

package/dist/strings/index.cjs

@@ -1 +1 @@
-"use strict";var e=require("../chunk-AJ25PWXX.cjs"),t=require("../chunk-2HSNUPEO.cjs");require("../chunk-4Z75R3IT.cjs");var r=require("../chunk-D3VSHABU.cjs");Object.defineProperty(exports,"getInitialsName",{enumerable:!0,get:function(){return e.getInitialsName}}),Object.defineProperty(exports,"replaceAt",{enumerable:!0,get:function(){return e.replaceAt}}),Object.defineProperty(exports,"normalizeSpaces",{enumerable:!0,get:function(){return t.normalizeSpaces}}),Object.defineProperty(exports,"normalizeString",{enumerable:!0,get:function(){return t.normalizeString}}),Object.defineProperty(exports,"removeSpaces",{enumerable:!0,get:function(){return t.removeSpaces}}),Object.defineProperty(exports,"stripHtmlTags",{enumerable:!0,get:function(){return t.stripHtmlTags}}),Object.defineProperty(exports,"capitalizeFirst",{enumerable:!0,get:function(){return r.capitalizeFirst}}),Object.defineProperty(exports,"capitalizeWords",{enumerable:!0,get:function(){return r.capitalizeWords}}),Object.defineProperty(exports,"slugify",{enumerable:!0,get:function(){return r.slugify}}),Object.defineProperty(exports,"toCamelCase",{enumerable:!0,get:function(){return r.toCamelCase}}),Object.defineProperty(exports,"toDotCase",{enumerable:!0,get:function(){return r.toDotCase}}),Object.defineProperty(exports,"toKebabCase",{enumerable:!0,get:function(){return r.toKebabCase}}),Object.defineProperty(exports,"toLowerCase",{enumerable:!0,get:function(){return r.toLowerCase}}),Object.defineProperty(exports,"toPascalCase",{enumerable:!0,get:function(){return r.toPascalCase}}),Object.defineProperty(exports,"toPascalCaseSpace",{enumerable:!0,get:function(){return r.toPascalCaseSpace}}),Object.defineProperty(exports,"toSnakeCase",{enumerable:!0,get:function(){return r.toSnakeCase}});
+"use strict";var e=require("../chunk-D3ENH7H6.cjs"),t=require("../chunk-E74U6CYP.cjs"),r=require("../chunk-2IOOEY45.cjs"),n=require("../chunk-KVAL5PAG.cjs");require("../chunk-E55EQK2U.cjs");var o=require("../chunk-PZQ6I4JJ.cjs");Object.defineProperty(exports,"capitalizeFirst",{enumerable:!0,get:function(){return e.capitalizeFirst}}),Object.defineProperty(exports,"capitalizeWords",{enumerable:!0,get:function(){return e.capitalizeWords}}),Object.defineProperty(exports,"getInitialsName",{enumerable:!0,get:function(){return e.getInitialsName}}),Object.defineProperty(exports,"replaceAt",{enumerable:!0,get:function(){return e.replaceAt}}),Object.defineProperty(exports,"stripHtmlTags",{enumerable:!0,get:function(){return e.stripHtmlTags}}),Object.defineProperty(exports,"normalizeString",{enumerable:!0,get:function(){return t.normalizeString}}),Object.defineProperty(exports,"normalizeSpaces",{enumerable:!0,get:function(){return r.normalizeSpaces}}),Object.defineProperty(exports,"removeSpaces",{enumerable:!0,get:function(){return n.removeSpaces}}),Object.defineProperty(exports,"slugify",{enumerable:!0,get:function(){return o.slugify}}),Object.defineProperty(exports,"toCamelCase",{enumerable:!0,get:function(){return o.toCamelCase}}),Object.defineProperty(exports,"toDotCase",{enumerable:!0,get:function(){return o.toDotCase}}),Object.defineProperty(exports,"toKebabCase",{enumerable:!0,get:function(){return o.toKebabCase}}),Object.defineProperty(exports,"toLowerCase",{enumerable:!0,get:function(){return o.toLowerCase}}),Object.defineProperty(exports,"toPascalCase",{enumerable:!0,get:function(){return o.toPascalCase}}),Object.defineProperty(exports,"toPascalCaseSpace",{enumerable:!0,get:function(){return o.toPascalCaseSpace}}),Object.defineProperty(exports,"toSnakeCase",{enumerable:!0,get:function(){return o.toSnakeCase}});