@rzl-zone/utils-js 3.2.6-beta.0 → 3.3.1

package/README.md

@@ -3,10 +3,10 @@
 </div>
 
 <p align="center">
-🚀 <strong>Rzl Utility JavaScript</strong> 🚀<br/>
-A lightweight, modern TypeScript utility library for Node.js & browser (via bundlers like Webpack/Vite).<br/>
-Provides reusable helpers to simplify your JavaScript / TypeScript projects.<br/>
-<strong>Built with ❤️ by <a href="https://github.com/rzl-app" target="_blank" rel="nofollow noreferrer noopener">@rzl-app</a>.</strong>
+🚀 <strong><u>Rzl Utility JS</u></strong> 🚀<br/>
+<i>A lightweight, modern TypeScript utility library for Node.js & browser (via bundlers like Webpack/Vite).</i><br/>
+<i>Provides reusable helpers to simplify your JavaScript or TypeScript projects.</i><br/>
+<strong><i>Built with ❤️ by <a href="https://github.com/rzl-app" target="_blank" rel="nofollow noreferrer noopener">@rzl-app</a>.</i></strong>
 </p>
 
 <div align="center">
@@ -19,7 +19,7 @@ Provides reusable helpers to simplify your JavaScript / TypeScript projects.<br/
   <img src="https://img.shields.io/npm/dt/@rzl-zone/utils-js?style=flat-rounded" alt="Downloads">
 </a>
 <a href="https://nodejs.org/en/" target="_blank" rel="nofollow noreferrer noopener">
-  <img src="https://img.shields.io/badge/node-≥16.0.0%20%7C%20≥18.17.0-blue.svg?logo=node.js&style=flat-rounded" alt="Node.js">
+  <img src="https://img.shields.io/badge/node-≥16.0.0-blue.svg?logo=node.js&style=flat-rounded" alt="Node.js">
 </a>
 <a href="https://github.com/rzl-zone/utils-js/blob/main/CONTRIBUTING.md" target="_blank" rel="nofollow noreferrer noopener">
   <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs Welcome">
@@ -39,13 +39,15 @@ Provides reusable helpers to simplify your JavaScript / TypeScript projects.<br/
 
 ---
  
-<h2 id="table-of-contents">📚 Table of Contents</h2>
+<h2 id="table-of-contents">📚 <strong>Table of Contents</strong></h2>
 
 - 💻 [Requirements](#requirements)
 - ⚙️ [Installation](#installation)
 - ✨ [Features](#features)
 - 🧬 [NextJS Support](#nextjs-support)
 - 💎 [Detailed Features](#detailed-features)
+  - [Full documentation](#full-documentation-rzl-utilsjs-is-currently-under-construction-%EF%B8%8F)
+  - [Hint Autocomplete](#hint-autocomplete)
 - 🔥 [Usage](#usage)
 - ❤️ [Sponsor](#sponsor-this-package)
 - 📜 [Changelog](#changelog)
@@ -56,35 +58,35 @@ Provides reusable helpers to simplify your JavaScript / TypeScript projects.<br/
 
 ---
 
-<h2 id="requirements">💻 Requirements</h2>
+<h2 id="requirements">💻 <strong>Requirements</strong></h2>
 
-- **Node.js `≥16.0.0` or `≥18.17.0`**  
+- **Node.js `≥16.0.0`**  
   This package leverages modern JavaScript & TypeScript features that require Node.js version 16.0.0 if not using Next.js, and for Next.js it must follow the official minimum Node.js version requirement depending on the version you use.  
   - 🔗 See official Next.js documentation: 
-      <a href="https://nextjs.org/docs/getting-started/installation#system-requirements" target="_blank" rel="nofollow noreferrer noopener">NextJS Installation Requirements</a>
+      <a href="https://nextjs.org/docs/getting-started/installation#system-requirements" target="_blank" rel="nofollow noreferrer noopener"><i>NextJS Installation Requirements.</i></a>
 
-- Works with:
+- **Works with:**
   - ✅ Node.js (16.0.0+) - Without NextJS
   - ✅ Node.js (18.17.0, or higher depending on NextJS version) - With NextJS
   - ✅ Modern browsers (via bundlers like Webpack / Vite)
 
 ---
 
-<h2 id="installation">⚙️ Installation</h2>
+<h2 id="installation">⚙️ <strong>Installation</strong></h2>
 
-#### With NPM
+#### *With NPM*
 
 ```bash
   npm install @rzl-zone/utils-js
 ```
 
-#### With Yarn
+#### *With Yarn*
 
 ```bash
   yarn add @rzl-zone/utils-js
 ```
 
-#### With PNPM
+#### *With PNPM*
 
 ```bash
   pnpm add @rzl-zone/utils-js
@@ -92,20 +94,20 @@ Provides reusable helpers to simplify your JavaScript / TypeScript projects.<br/
 
 ---
 
-<h2 id="features">✨ Features</h2>
+<h2 id="features">✨ <strong>Features</strong></h2>
 
 - 🚀 Written in **TypeScript** — fully typed & safe
 - ⚡ Small, tree-shakable & fast
 - 📦 Works in **Node.js** & modern browsers
 - ❤️ Simple API, easy to extend
 - 🧬 **Next.js support**: helpers for dynamic routes, building URLs, reading env, extracting client IP
-- 🛠 Additional TypeScript types: `OmitStrict`, `PartialByKeys`, etc.
+- 🛠 Additional TypeScript types: `OmitStrict`, `PartialOnly`, etc.
 
 ---
 
-<h2 id="nextjs-support">🧬 Next.js Support</h2>
+<h2 id="nextjs-support">🧬 <strong>Next.js Support</strong></h2>
 
-This package also provides utilities specially built for Next.js environments, neatly separated into their own entry points:
+**This package also provides utilities specially built for Next.js environments, neatly separated into their own entry points:**
 
 - <h3 id="nextjs-support--globals">`@rzl-zone/utils-js/next`</h3>  
   Helpers for building URLs, generating dynamic routes, reading environment variables, etc.   
@@ -125,32 +127,61 @@ This package also provides utilities specially built for Next.js environments, n
 
 ---
 
-<h2 id="detailed-features">💎 Detailed Features</h2>
+<h2 id="detailed-features">💎 <strong>Detailed Features</strong></h2>
 
-  ### Full documentation <a href="https://docs-rzl-utils-js.vercel.app" target="_blank" rel="nofollow noreferrer noopener">Rzl UtilsJS</a> is **currently under construction** 🏗️.
+  ### **Full documentation <a href="https://docs-rzl-utils-js.vercel.app" target="_blank" rel="nofollow noreferrer noopener">Rzl UtilsJS</a> is **currently under construction** 🏗️.**
   #### For now, explore the examples or dive into the source — all utilities are documented via **TSDoc** and typed properly.
   
   ```ts
   import { | } from "@rzl-zone/utils-js/assertions";
-  import { | } from "@rzl-zone/utils-js/conversions";
-  import { | } from "@rzl-zone/utils-js/env";
+  import { | } from "@rzl-zone/utils-js/conversions"; 
   import { | } from "@rzl-zone/utils-js/events";
-  import { | } from "@rzl-zone/utils-js/formatting";
-  import { | } from "@rzl-zone/utils-js/generator";
-  import { | } from "@rzl-zone/utils-js/generator";
+  import { | } from "@rzl-zone/utils-js/formatters";
+  import { | } from "@rzl-zone/utils-js/generators";
   import { | } from "@rzl-zone/utils-js/next";
   import { | } from "@rzl-zone/utils-js/next/server";
   import { | } from "@rzl-zone/utils-js/operations";
   import { | } from "@rzl-zone/utils-js/parsers";
   import { | } from "@rzl-zone/utils-js/predicates";
-  import { | } from "@rzl-zone/utils-js/promise";
+  import { | } from "@rzl-zone/utils-js/promises";
   import { | } from "@rzl-zone/utils-js/strings";
-  import { | } from "@rzl-zone/utils-js/stylings";
+  import { | } from "@rzl-zone/utils-js/tailwind";
   import { | } from "@rzl-zone/utils-js/urls";
 
   import type { | } from "@rzl-zone/utils-js/types";
   ```
-  #### Just place your cursor right inside `{ }` or from after import from `"@rzl-zone/utils-js/"` like the pipe ("|") above then ctrl + space, there are many functions or types and then hover to each function is complete with how to use it because I have added tsDoc.
+  #### Place your cursor inside { } or after "@rzl-zone/utils-js/{{ | }}" then press Ctrl+Space to see all available functions/types with full TSDoc hints.
+  ---
+  ### **Hint: Autocomplete**
+
+  **To get the best autocomplete hints for folders and files, add the `types` field in your configuration file:**
+
+  #### # **_TypeScript_**:
+  Add this to your `tsconfig.json`:
+  ```jsonc
+  // tsconfig.json
+  {
+    "compilerOptions": {
+      "types": [
+        "@rzl-zone/utils-js"
+      ]
+    }
+  }
+
+  ```
+  #### # **_JavaScript_:**
+  Add this to your `jsconfig.json`:
+  ```jsonc
+  // jsconfig.json
+  {
+    "compilerOptions": {
+      "types": [
+        "@rzl-zone/utils-js"
+      ]
+    }
+  }
+  ```
+  >ℹ️ ***Tip:*** *For JS projects, consider adding "checkJs": true for better IntelliSense.*
 
   <!-- - <h4 id="detailed-features--assertions">
       Assertions - 
@@ -175,70 +206,70 @@ This package also provides utilities specially built for Next.js environments, n
        -->
 ---
 
-<h2 id="usage">🔥 Usage</h2>
+<h2 id="usage">🔥 <strong>Usage</strong></h2>
 
-### Easy to use, just import on your code base.
+### **Easy to use, just import on your code base.**
 
-#### Example Function Import:
+#### *Example Function Import:*
 
 ```ts
-import { isServer } from "@rzl-zone/utils-js/env";
+import { isServer } from "@rzl-zone/utils-js/predicates";
 
 console.log(isServer());
-// true if running on Node.js, false if browser
+// ➔ `true` if running on server-side, `false` if in browser.
 ```
 
-#### Example Types Helper Import:
+#### *Example Types Helper Import:*
 
 ```ts
 import type { OmitStrict } from "@rzl-zone/utils-js/types";
 
-type MyType = OmitStrict<OtherType, "omitedProps">;
+type MyType = OmitStrict<OtherType, "omittingProps">;
 // Fully strict TS omit that requires all keys to exist in target
 ```
 
 ---
 
-<h2 id="sponsor-this-package">❤️ Sponsor this package</h2>
+<h2 id="sponsor-this-package">❤️ <strong>Sponsor this package</strong></h2>
 
-Help support development:  
-[👉 Become a sponsor](https://github.com/sponsors/rzl-app)
+**Help support development:**    
+*[👉 Become a sponsor](https://github.com/sponsors/rzl-app)*
 
 ---
 
-<h2 id="changelog">📝 Changelog</h2>
+<h2 id="changelog">📝 <strong>Changelog</strong></h2>
 
-See [CHANGELOG](CHANGELOG.md).
+**See [CHANGELOG](CHANGELOG.md).**
 
 ---
 
-<h2 id="contributing">🤝 Contributing</h2>
+<h2 id="contributing">🤝 <strong>Contributing</strong></h2>
 
-See [CONTRIBUTING](CONTRIBUTING.md).
+**See [CONTRIBUTING](CONTRIBUTING.md).**
 
 ---
 
-<h2 id="security">🔒 Security</h2>
+<h2 id="security">🔒 <strong>Security</strong></h2>
 
-Please report issues to [rizalvindwiky1998@gmail.com](mailto:rizalvindwiky1998@gmail.com).
+**Please report issues to [rizalvindwiky1998@gmail.com](mailto:rizalvindwiky1998@gmail.com).**
 
 ---
 
-<h2 id="credits">🙌 Credits</h2>
+<h2 id="credits">🙌 <strong>Credits</strong></h2>
 
-- [Rzl App](https://github.com/rzl-app)
-- [All Contributors](../../contributors)
+**- [Rzl App](https://github.com/rzl-app)**  
+**- [All Contributors](../../contributors)**
 
 ---
 
-<h2 id="license">📜 License</h2>
+<h2 id="license">📜 <strong>License</strong></h2>
 
-The MIT License (MIT).  
-Please see [License File](LICENSE.md) for more information.
+**The MIT License (MIT).**    
+*Please see **[License File](LICENSE.md)** for more information.*
 
 ---
 
 ✅ **Enjoy using `@rzl-zone/utils-js`?**  
-Star this repo ⭐ and share it with other JavaScript developers!
+*Star this repo [⭐](https://github.com/rzl-zone/utils-js) and share it with other JavaScript developers!*
 
 ---

package/dist/NumberRangeUnion-B6bhM2s7.d.ts

@@ -0,0 +1,33 @@
+/** --------------------------------------------------
+ * * ***Internal Utility Type for: {@link NumberRangeUnion | `NumberRangeUnion`}.***
+ * --------------------------------------------------
+ * @template N - Starting/Ending number of the range (inclusive).
+ * @template Acc - Internal accumulator for recursion (do not set manually).
+ */
+type Enumerate<N extends number,Acc extends number[]=[]>=Acc["length"] extends N?Acc[number]:Enumerate<N,[...Acc,Acc["length"]]>;
+/** --------------------------------------------------
+ * * ***Utility Type: `NumberRangeUnion`.***
+ * --------------------------------------------------
+ * **Generate a union type of numbers from `From` to `To` using enumeration.**
+ * @description
+ * Produces a **numeric union type** from `From` to `To` (inclusive),
+ * using a simpler approach based on `Enumerate<N>` helper type.
+ * - ✅ Straightforward & easy to reason about.
+ * - ⚠️ Still limited by TypeScript recursion depth (safe up to `999`).
+ * - ⚙️ Best used for **smaller ranges** (`≤ 100`) or when readability matters.
+ * - ℹ️ For **larger ranges** (`≥ 101`) use {@link NumberRangeLimit | `NumberRangeLimit`} instead.
+ * @template From - Starting number of the range (inclusive).
+ * @template To - Ending number of the range (inclusive).
+ * @example
+ * ```ts
+ * type RangeA = NumberRangeUnion<3, 6>;
+ * // ➔ 3 | 4 | 5 | 6
+ * type RangeB = NumberRangeUnion<0, 2>;
+ * // ➔ 0 | 1 | 2
+ * type RangeC = NumberRangeUnion<8, 8>;
+ * // ➔ 8
+ * type RangeD = NumberRangeUnion<20, 10>;
+ * // ➔ 10
+ * ```
+ */
+type NumberRangeUnion<From extends number,To extends number>=From extends To?From:Exclude<Enumerate<To>,Enumerate<From>>extends never?To:Exclude<Enumerate<To>,Enumerate<From>>|To;export type{NumberRangeUnion as N};

package/dist/{any-BmdI8UbK.d.ts → any-v4TsK9ES.d.ts}

@@ -1,11 +1,11 @@
-import{I as If}from'./if-CvT4R7Kh.js';
+import{I as If}from'./if-ChM35c_q.js';
 /** -------------------------------------------------------
- * * ***IsAny.***
+ * * ***Utility Type: `IsAny`.***
  * -------------------------------------------------------
- * A type-level utility that checks whether a type is ***`any`***.
- * - Returns `true` if `T` is `any`.
- * - Returns `false` otherwise.
- *
+ * **A type-level utility that checks whether a type is ***`any`***.**
+ * - **Behavior:**
+ *    - Returns `true` if `T` is `any`.
+ *    - Returns `false` for otherwise.
  * @template T - The type to evaluate.
  * @example
  * ```ts
@@ -17,18 +17,16 @@ import{I as If}from'./if-CvT4R7Kh.js';
  */
 type IsAny<T>=0 extends 1 & T?true:false;
 /** -------------------------------------------------------
- * * ***IfAny.***
+ * * ***Utility Type: `IfAny`.***
  * -------------------------------------------------------
- *
- * A type-level conditional utility that returns one type if ***`T` is `any`***,
- * and another type otherwise.
- * - Defaults to `true` when `T` is `any`.
- * - Defaults to `false` otherwise.
- *
+ * **A type-level conditional utility that returns one type if ***`T` is `any`***,
+ * and another type otherwise.**
+ * - **Behavior:**
+ *    - Defaults to `true` when `T` is `any`.
+ *    - Defaults to `false` for otherwise.
  * @template T - The type to check.
- * @template IfTrue - The type to return if `T` is `any`. *(default: `true`)*
- * @template IfFalse - The type to return if `T` is not `any`. *(default: `false`)*
- *
+ * @template IfTrue - The type to return if `T` is `any`, *(default: `true`)*.
+ * @template IfFalse - The type to return if `T` is not `any`, *(default: `false`)*.
  * @example
  * ```ts
  * type A = IfAny<any, string, number>;
@@ -38,7 +36,9 @@ type IsAny<T>=0 extends 1 & T?true:false;
  * ```
  */
 type IfAny<T,IfTrue=true,IfFalse=false>=If<IsAny<T>,IfTrue,IfFalse>;
-/** Configuration options for a type-level utility `AnifyProperties`. */
+/** * ***Configuration options for a type-level utility for
+ * {@link AnifyProperties | `AnifyProperties`}.***
+ */
 type AnifyPropertiesOptions={
 /** If `makeOptional: true`, all properties become optional, otherwise, all properties are required and typed as `any`, defaultValue: `false`.
  *
@@ -46,20 +46,19 @@ type AnifyPropertiesOptions={
  */
 makeOptional:boolean;};
 /** -------------------------------------------------------
- * * ***AnifyProperties.***
+ * * ***Utility Type: `AnifyProperties`.***
  * -------------------------------------------------------
- *
- * A type-level utility that transforms all properties of an object into ***`any`***.
- * - If `makeOptional: true`, all properties become optional.
- * - Otherwise, all properties are required and typed as `any`.
- *
- * @template T - The object type to transform.
- * @template Options - Configuration options. Defaults to `{ makeOptional: false }`.
+ * **A type-level utility that transforms all properties of an object
+ * into ***`any`***.**
+ * - **Behavior:**
+ *    - If `makeOptional: true`, all properties become optional.
+ *    - Otherwise, all properties are required and typed as `any`.
+ * @template T The object type to transform.
+ * @template Options Configuration options, defaults to `{ makeOptional: false }`.
  * @example
  * ```ts
  * type A = AnifyProperties<{a: string; b: number}>;
  * // ➔ { a: any; b: any }
- *
  * type B = AnifyProperties<{a: string; b: number}, { makeOptional: true }>;
  * // ➔ { a?: any; b?: any }
  * ```

package/dist/{arrays-normalize-recursive-CnjYJ9xg.d.ts → arrays-normalize-recursive-BqmVuFlD.d.ts}

@@ -1,11 +1,11 @@
 /** -------------------------------------------------------
- * * ***FixNeverArrayRecursive.***
+ * * ***Utility Type: `FixNeverArrayRecursive`.***
  * -------------------------------------------------------
- * A type-level utility that **recursively transforms arrays of type `never[]` into empty arrays**.
- * - Preserves `readonly` modifiers.
- * - Applies recursively for nested arrays.
- * - Leaves other types unchanged.
- *
+ * **A type-level utility that **recursively transforms arrays of type `never[]` into empty arrays**.**
+ * - **Behavior:**
+ *    - Preserves `readonly` modifiers.
+ *    - Applies recursively for nested arrays.
+ *    - Leaves other types unchanged.
  * @template T - The input type to recursively fix.
  * @example
  * ```ts
@@ -23,13 +23,13 @@
  */
 type FixNeverArrayRecursive<T>=T extends readonly never[]?T extends never[]?[]:readonly []:T extends(infer U)[]?FixNeverArrayRecursive<U>[]:T extends readonly(infer U)[]?readonly FixNeverArrayRecursive<U>[]:T;
 /** -------------------------------------------------------
- * * ***NormalizeEmptyArraysRecursive.***
+ * * ***Utility Type: `NormalizeEmptyArraysRecursive`.***
  * -------------------------------------------------------
- * A type-level utility that **recursively normalizes empty array types** by converting arrays whose element type is `never`, `null`, or `undefined` into empty tuple types (`[]`).
- * - Preserves `readonly` modifiers.
- * - Recurses into nested arrays.
- * - Leaves other array types unchanged.
- *
+ * **A type-level utility that **recursively normalizes empty array types** by converting arrays whose element type is `never`, `null`, or `undefined` into empty tuple types (`[]`).**
+ * - **Behavior:**
+ *    - Preserves `readonly` modifiers.
+ *    - Recurses into nested arrays.
+ *    - Leaves other array types unchanged.
  * @template T - The input type to normalize.
  * @example
  * ```ts
@@ -47,15 +47,15 @@ type FixNeverArrayRecursive<T>=T extends readonly never[]?T extends never[]?[]:r
  */
 type NormalizeEmptyArraysRecursive<T>=T extends readonly(infer U)[]?U extends never|null|undefined?T extends readonly unknown[]?T extends(infer E)[]?[]:readonly []:never:T extends(infer E)[]?NormalizeEmptyArraysRecursive<U>[]:readonly NormalizeEmptyArraysRecursive<U>[]:T;
 /** -------------------------------------------------------
- * * ***RemoveEmptyArrayElements.***
+ * * ***Utility Type: `RemoveEmptyArrayElements`.***
  * -------------------------------------------------------
- * A type-level utility that **recursively removes empty array elements (`[]`) from a tuple type**.
- * - If `T` is a tuple, checks the first element:
- *    - If `Head` is an empty array type (`[]`), it is removed.
- *    - Otherwise, `Head` is preserved.
- * - Repeats recursively on the rest of the tuple.
- * - Leaves non-tuple types unchanged.
- *
+ * **A type-level utility that **recursively removes empty array elements (`[]`) from a tuple type**.**
+ * - **Behavior:**
+ *    - If `T` is a tuple, checks the first element:
+ *        - If `Head` is an empty array type (`[]`), it is removed.
+ *        - Otherwise, `Head` is preserved.
+ *    - Repeats recursively on the rest of the tuple.
+ *    - Leaves non-tuple types unchanged.
  * @template T - The tuple type to process.
  * @example
  * ```ts

package/dist/assertions/index.cjs

@@ -1 +1 @@
-"use strict";var e=require("../chunk-GGWPB23G.cjs"),r=require("../chunk-VHAPTHEA.cjs"),t=require("../chunk-VCFXNV3Q.cjs");require("../chunk-UDA26MCU.cjs");var s=require("../chunk-D3VSHABU.cjs");Object.defineProperty(exports,"assertIsBigInt",{enumerable:!0,get:function(){return e.assertIsBigInt}}),Object.defineProperty(exports,"assertIsNumber",{enumerable:!0,get:function(){return e.assertIsNumber}}),Object.defineProperty(exports,"assertIsArray",{enumerable:!0,get:function(){return r.assertIsArray}}),Object.defineProperty(exports,"assertIsString",{enumerable:!0,get:function(){return t.assertIsString}}),Object.defineProperty(exports,"assertIsBoolean",{enumerable:!0,get:function(){return s.assertIsBoolean}}),Object.defineProperty(exports,"assertIsPlainObject",{enumerable:!0,get:function(){return s.assertIsPlainObject}});
+"use strict";var e=require("../chunk-IVL7CKVH.cjs"),r=require("../chunk-HYRQMTRH.cjs"),t=require("../chunk-6JFZL7YE.cjs");require("../chunk-UDA26MCU.cjs");var s=require("../chunk-PZQ6I4JJ.cjs");Object.defineProperty(exports,"assertIsBigInt",{enumerable:!0,get:function(){return e.assertIsBigInt}}),Object.defineProperty(exports,"assertIsNumber",{enumerable:!0,get:function(){return e.assertIsNumber}}),Object.defineProperty(exports,"assertIsString",{enumerable:!0,get:function(){return r.assertIsString}}),Object.defineProperty(exports,"assertIsArray",{enumerable:!0,get:function(){return t.assertIsArray}}),Object.defineProperty(exports,"assertIsBoolean",{enumerable:!0,get:function(){return s.assertIsBoolean}}),Object.defineProperty(exports,"assertIsPlainObject",{enumerable:!0,get:function(){return s.assertIsPlainObject}});