@rzl-zone/utils-js 3.1.2-beta.0 → 3.2.0

package/dist/formatters/index.js

@@ -0,0 +1 @@
+export{censorEmail,chunkString,formatCurrency,formatDateFns,formatDateIntl,formatDateTime,formatNumber,formatPhoneNumber,getGMTOffset,truncateString}from"../chunk-YKPSRP5G.js";import"../chunk-T2T7K3KR.js";import"../chunk-IRFL4MAX.js";import"../chunk-3IBQ5MOM.js";import"../chunk-WVSPXFTY.js";import"../chunk-W2WNBUDE.js";import"../chunk-SBKGWRS5.js";import"../chunk-PET42Z7W.js";import"../chunk-QNKGP5DY.js";import"../chunk-CMW2TBOQ.js";

package/dist/generators/index.cjs

@@ -0,0 +1 @@
+"use strict";var e=require("../chunk-5757UBXJ.cjs");require("../chunk-DVMHRLKP.cjs");var r=require("../chunk-BAV5T2E3.cjs");require("../chunk-T7PU2V7X.cjs"),require("../chunk-UDA26MCU.cjs"),require("../chunk-PZQ6I4JJ.cjs"),Object.defineProperty(exports,"getRandomItem",{enumerable:!0,get:function(){return e.getRandomItem}}),Object.defineProperty(exports,"randomInt",{enumerable:!0,get:function(){return e.randomInt}}),Object.defineProperty(exports,"randomIntByLength",{enumerable:!0,get:function(){return e.randomIntByLength}}),Object.defineProperty(exports,"randomStr",{enumerable:!0,get:function(){return e.randomStr}}),Object.defineProperty(exports,"noop",{enumerable:!0,get:function(){return r.noop}});

package/dist/{generator → generators}/index.d.ts

@@ -1,44 +1,10 @@
-import{f as IfNonEmptyArray,E as Extends}from'../extends-Bk_SBGdT.js';import{F as FixNeverArrayRecursive}from'../arrays-normalize-recursive-CnjYJ9xg.js';import{g as NullToUndefined}from'../nils-DMz3kU7M.js';import'../if-CvT4R7Kh.js';import'../never-BfayMBF9.js';type OptionsRandomStr={
-/** Ensures no whitespace characters in the generated string, defaultValue: `true`.
- *
- * @default true
- */
-avoidWhiteSpace?:boolean;
-/** Custom characters to replace the default number set if `type` is `"number"`, defaultValue: `undefined`.
- *
- * @default undefined
- */
-replaceGenInt?:string;
-/** Custom characters to replace the default string set if `type` is `"string"`, defaultValue: `undefined`.
- *
- * @default undefined
- */
-replaceGenStr?:string;
-/** Additional characters to include in the generated string, defaultValue: `undefined`.
- *
- * @default undefined
- */
-addChar?:string;
-/** Minimum length of the generated string (1 to 5000), defaultValue: `40`.
- *
- * @default 40
- */
-minLength?:number;
-/** Maximum length of the generated string (1 to 5000), defaultValue: `40`.
- *
- * @default 40
- */
-maxLength?:number;
-/** Type of output: `"string"` or `"number"`, defaultValue: `"string"`.
- *
- * @default "string"
- */
-type?:"string"|"number";};
+import{f as IfNonEmptyArray,E as Extends}from'../extends-DtdRjDyU.js';import{F as FixNeverArrayRecursive}from'../arrays-normalize-recursive-BqmVuFlD.js';import{g as NullToUndefined}from'../nils-CO8zLHSB.js';import'../if-ChM35c_q.js';import'../never-D89PbPh5.js';
 /** ---------------------------------
- * * ***Returns a random element from a given array.***
+ * * ***Utility: `getRandomItem`.***
  * ---------------------------------
+ * **Function to get a random element from a given array.**
  * @template T - The type of the input array.
- * @param {*} array - The input array. Can be `null`, `undefined`, or an empty array.
+ * @param {*} array - The input array, can be `null`, `undefined`, or an empty array.
  * @returns
  * - If `array` is a non-empty tuple, returns one of its elements.
  * - If `array` is empty, `null`, or `undefined`, returns `undefined`.
@@ -66,13 +32,12 @@ type?:"string"|"number";};
  */
 declare function getRandomItem(array:undefined):undefined;declare function getRandomItem(array:null):undefined;declare function getRandomItem(array:[]):undefined;declare function getRandomItem<T extends readonly unknown[]>(array:T):T extends never[][]?[]:number extends T["length"]?NullToUndefined<FixNeverArrayRecursive<T[number]>>:IfNonEmptyArray<T,NullToUndefined<FixNeverArrayRecursive<T[number]>>,undefined>;declare function getRandomItem<T extends readonly unknown[]|undefined|null>(array:T):T extends readonly unknown[]?NullToUndefined<FixNeverArrayRecursive<T[number]>>|undefined:undefined;declare function getRandomItem<T>(array:T):unknown extends T?unknown:Extends<any[]|readonly any[],T>extends true?Extract<T,unknown[]|readonly unknown[]>[number]|undefined:Extends<any[],T>extends true?Extract<T,unknown[]|readonly unknown[]>[number]|undefined:Extends<readonly any[],T>extends true?Extract<T,unknown[]|readonly unknown[]>[number]|undefined:undefined;
 /** -----------------------------------------------------------------------
- * * ***Generates a random integer within a specified range (inclusive).***
+ * * ***Utility: `randomInt`.***
  * ------------------------------------------------------------------------
- * Generates a random integer between `min` and `max` (inclusive), with safety constraints:
- * - `min` will be forced to be at least `1`.
- * - `max` will be capped at `Number.MAX_SAFE_INTEGER`.
- *
- * Validates input parameters to ensure robust behavior.
+ * **Generates a random integer within a specified range (inclusive).**
+ * - **Generates a random integer between `min` and `max` (inclusive), with safety constraints:**
+ *    - `min` will be forced to be at least `1`.
+ *    - `max` will be capped at `Number.MAX_SAFE_INTEGER`.
  * @param {number} min - The minimum value (inclusive), must be an integer.
  * @param {number} max - The maximum value (inclusive), must be an integer.
  * @returns {number} A random integer N where `min ≤ N ≤ max`.
@@ -106,18 +71,20 @@ maxLength?:number;
  */
 avoidZero?:boolean;};
 /** ----------------------------------------------------------------------------
- * * ***Generates a random integer within a specified range of digit lengths.***
+ * * ***Utility: `randomIntByLength`.***
  * -----------------------------------------------------------------------------
- * **This function allows generating random integers that strictly conform to a specified minimum and
+ * **Generates a random integer within a specified range of digit lengths.**
+ * @description
+ * This function allows generating random integers that strictly conform to a specified minimum and
  * maximum digit length, it is useful for scenarios such as generating realistic-looking IDs, codes,
- * or random test data.**
+ * or random test data.
  * - **The function ensures:**
  *    - `minLength` is at least 1 and not greater than `maxLength`.
- *    - `maxLength` is no more than 16 (due to JavaScript's Number.MAX_SAFE_INTEGER).
+ *    - `maxLength` is no more than 16 (due to JavaScript's `Number.MAX_SAFE_INTEGER`).
  *    - If `avoidZero` is `true`, ensures that `0` is never returned.
  * @param {OptionsRandomIntByLength} [options] - Configuration options.
- * @param {OptionsRandomIntByLength["minLength"]} [options.minLength=1] - Minimum number of digits (must be ≥1 and ≤ `maxLength`).
- * @param {OptionsRandomIntByLength["maxLength"]} [options.maxLength=16] - Maximum number of digits (must be ≤16).
+ * @param {OptionsRandomIntByLength["minLength"]} [options.minLength=1] - Minimum number of digits (must be ≥ `1` and ≤ `maxLength`).
+ * @param {OptionsRandomIntByLength["maxLength"]} [options.maxLength=16] - Maximum number of digits (must be ≤ `16`).
  * @param {OptionsRandomIntByLength["avoidZero"]} [options.avoidZero=false] - If true, will ensure the result is never zero.
  * @returns {number} A randomly generated integer within the specified constraints.
  * @throws {TypeError} If parameters are invalid, such as:
@@ -133,13 +100,43 @@ avoidZero?:boolean;};
  * randomIntByLength({ avoidZero: true });
  * // ➔ never 0
  */
-declare const randomIntByLength:(options?:OptionsRandomIntByLength)=>number;
+declare const randomIntByLength:(options?:OptionsRandomIntByLength)=>number;type OptionsRandomStr={
+/** ***Ensures no whitespace characters in the generated string, defaultValue: `true`.***
+ * @default true
+ */
+avoidWhiteSpace?:boolean;
+/** ***Custom characters to replace the default number set if `type` is `"number"`, defaultValue: `undefined`.***
+ * @default undefined
+ */
+replaceGenInt?:string;
+/** ***Custom characters to replace the default string set if `type` is `"string"`, defaultValue: `undefined`.***
+ * @default undefined
+ */
+replaceGenStr?:string;
+/** ***Additional characters to include in the generated string, defaultValue: `undefined`.***
+ * @default undefined
+ */
+addChar?:string;
+/** ***Minimum length of the generated string (1 to 5000), defaultValue: `40`.***
+ * @default 40
+ */
+minLength?:number;
+/** ***Maximum length of the generated string (1 to 5000), defaultValue: `40`.***
+ * @default 40
+ */
+maxLength?:number;
+/** ***Type of output: `"string"` or `"number"`, defaultValue: `"string"`.***
+ * @default "string"
+ */
+type?:"string"|"number";};
 /** ---------------------------------------------------------------------------------
- * * ***Generates a random alphanumeric string or number with a specified length range.***
+ * * ***Utility: `randomStr`.***
  * ---------------------------------------------------------------------------------
- * **This function allows you to generate random strings or numbers with fully
+ * **Generates a random alphanumeric string or number with a specified length range.**
+ * @description
+ * This function allows you to generate random strings or numbers with fully
  * customizable options, such as length range, character sets, inclusion of
- * additional characters, and whether to avoid whitespace.**
+ * additional characters, and whether to avoid whitespace.
  * @param {OptionsRandomStr} [options] - Configuration options for generating the string.
  * @param {OptionsRandomStr["minLength"]} [options.minLength=40] - Minimum length of the generated string (must be `≥` `1`).
  * @param {OptionsRandomStr["maxLength"]} [options.maxLength=40] - Maximum length of the generated string (must be `≤` `5000`).
@@ -164,9 +161,10 @@ declare const randomIntByLength:(options?:OptionsRandomIntByLength)=>number;
  */
 declare const randomStr:(options?:OptionsRandomStr)=>string;
 /** --------------------------------------------------
- * * ***A no-operation function that always returns `undefined`.***
+ * * ***Utility: `noop`.***
  * --------------------------------------------------
- * **Useful as a default callback, placeholder, or stub function.**
+ * **A no-operation function that always returns `undefined`.**
+ * - *Useful as a default callback, placeholder, or stub function.*
  * @returns {undefined} Always returns `undefined`.
  * @example
  * // Direct call returns undefined
@@ -174,9 +172,9 @@ declare const randomStr:(options?:OptionsRandomStr)=>string;
  * // ➔ undefined
  *
  * // Can be used with type-checking helpers
- * isUndefined(noop());  // ➔ true
- * isFunction(noop);     // ➔ true
- * isFunction(noop());   // ➔ false
+ * isFunction(noop);    // ➔ true
+ * isUndefined(noop()); // ➔ true
+ * isFunction(noop());  // ➔ false
  *
  * // Often used as a default function
  * const callback = noop;

package/dist/generators/index.js

@@ -0,0 +1 @@
+export{getRandomItem,randomInt,randomIntByLength,randomStr}from"../chunk-DEZZUYE2.js";import"../chunk-WVSPXFTY.js";export{noop}from"../chunk-YWHHVDT4.js";import"../chunk-PET42Z7W.js";import"../chunk-QNKGP5DY.js";import"../chunk-CMW2TBOQ.js";

package/dist/{if-CvT4R7Kh.d.ts → if-ChM35c_q.d.ts}

@@ -1,12 +1,13 @@
 /** -------------------------------------------------------
- * * ***If.***
+ * * ***Utility Type: `If`.***
  * -------------------------------------------------------
- * Conditional: returns the second argument if the first argument is `true`, otherwise returns the third argument.
+ * - **Conditional:**
+ *    - Returns the second argument if the first argument is `true`, 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 `true`. (default: `true`)
- * @template IfFalse - The branch type if condition is `false`. (default: `false`)
+ * @template IfTrue - The branch type if condition is `true`. (default: `true`).
+ * @template IfFalse - The branch type if condition is `false`. (default: `false`).
  * @example
  * ```ts
  * type A = If<true, "valid">;