Utils JS
A lightweight, modern TypeScript utility library for Node.js & browser (via bundlers like Webpack, Turbopack, Rollup, esbuild, and higher-level tools like Vite, tsup and tsdown).
It provides reusable helpers to simplify everyday JavaScript and TypeScript tasks projects.
Built with β€οΈ by @rzl-zone.
---
π Table of Contents
- π» [Requirements](#requirements)
- βοΈ [Installation](#installation)
- β¨ [Features](#features)
- π [Detailed Features](#detailed-features)
- [Full Documentation](#detailed-features--full-documentation)
- [CDN Usage](#detailed-features--cdn-usage)
- [Hint Autocomplete](#detailed-features--hint-autocomplete-setup)
- π₯ [Usage](#usage)
- β€οΈ [Sponsor](#sponsor-this-package)
- π [Changelog](#changelog)
- π€ [Contributing](#contributing)
- π [Security](#security)
- π [Credits](#credits)
- π [License](#license)
---
π» Requirements
- **Node.js `β₯18.18.0`**
This package leverages modern JavaScript & TypeScript features that require Node.js version 18.18.0.
- **Works with:**
- β
Node.js (18.18.0+).
- β
Modern browsers (via **ESM-compatible** bundlers such as [`Webpack`](https://webpack.js.org/), [`Turbopack`](https://vercel.com/blog/turbopack), [`Rollup`](https://rollupjs.org/), [`esbuild`](https://esbuild.github.io/), and higher-level tools like [`Vite`](https://vite.dev/), [`tsup`](https://tsup.egoist.dev/), and [`tsdown`](https://tsdown.dev/)).
- **TypeScript Build Info:**
- Target: `ES2022`.
- Module: `ES2022`.
- Module Resolution: `bundler`.
> βΉοΈ Note:
> These TypeScript settings are used to build the package, consumers do **not** need to match these settings unless they plan to build or modify the source code.
---
βοΈ Installation
#### *With NPM*
```bash
npm install @rzl-zone/utils-js@latest
```
#### *With Yarn*
```bash
yarn add @rzl-zone/utils-js@latest
```
#### *With PNPM*
```bash
pnpm add @rzl-zone/utils-js@latest
```
---
β¨ Features
- π Written in **TypeScript** β fully typed & safe.
- β‘ Small, tree-shakable & fast.
- π¦ Works in **Node.js** & modern browsers.
- β€οΈ Simple API, easy to extend.
---
𧬠Next.js Support
> β οΈ Starting from version `3.13.0`, the following Next.js entry points were removed from `@rzl-zone/utils-js` and migrated into the dedicated package @rzl-zone/next-kit.
>
> Migrated entry points:
>
> - `@rzl-zone/utils-js/next` β `@rzl-zone/next-kit/utils`
> - `@rzl-zone/utils-js/next/server` β `@rzl-zone/next-kit/utils/server`
---
π Detailed Features
The full UtilsJS documentation 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/errors";
import { /* β¦ */ } from "@rzl-zone/utils-js/events";
import { /* β¦ */ } from "@rzl-zone/utils-js/formatters";
import { /* β¦ */ } from "@rzl-zone/utils-js/generators";
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/promises";
import { /* β¦ */ } from "@rzl-zone/utils-js/strings";
import { /* β¦ */ } from "@rzl-zone/utils-js/tailwind";
import { /* β¦ */ } from "@rzl-zone/utils-js/urls";
```
#### Place your cursor inside `{ }` or right after the package path `@rzl-zone/utils-js/`, then press Ctrl+Space (Windows/Linux) or Cmd+Space (macOS), or use your editorβs autocomplete shortcut, to see all available functions and types with full TSDoc hints.
---
CDN Usage.
#### **Including via CDN:**
```xml
```
> β οΈ **Note:**
> When using the library via CDN in the browser:
>
> - Always include first the `` tag before your own scripts when using the CDN version.
> - Some Node.js-specific utilities may **not** be available, e.g.:
> - Category utils of `tailwind`.
> - Any `server-only` features will **not** be available.
> - The global object provided is `RzlUtilsJs`.
> - The CDN bundle is **~373KB+ minified**, for production, consider using bundlers or npm packages for smaller size and tree-shaking.
---
Hint: Autocomplete Setup (Step by Step).
Improve TypeScript editor import suggestions for `@rzl-zone/utils-js`, so all functions, types, and modules appear instantly when triggering autocomplete β press `Ctrl+Space` (**Windows/Linux**), `β+Space` (**macOS**), or your editorβs autocomplete shortcut.
This works across modern TypeScript-supported editors (e.g., `VSCode`, `WebStorm`, `Vim extensions`, `NeoVim LSP`, `Cursor`) without requiring triple-slash references β the package is fully indexed automatically through your editorβs TypeScript language service, follow steps:
- 1οΈβ£ **Install @rzl-zone/utils-js.**
- Make sure the package is installed, see [**Installation Guide**](#installation).
- 2οΈβ£ **Create a types folder.**
- Inside your project root, make a folder called `types`:
```pgsql
project-root/
ββ src/
ββ types/
β ββ index.d.ts
ββ tsconfig.json
ββ jsconfig.json
```
- 3οΈβ£ **Add the global reference file.**
- Create `types/index.d.ts` with this content:
```ts
///
```
- You can add more references here if needed, for example:
```ts
///
// eg more references (if needed):
///
///
```
- 4οΈβ£ **Update tsconfig.json.**
- Make sure add `types` folder to `"include"`, so **TypeScript** automatically picks up your types folder:
```jsonc
// tsconfig.json
{
"compilerOptions": {
"strict": true,
// other your config...
},
"include": ["src", "types"]
// other your config...
}
```
- 5οΈβ£ **Update jsconfig.json (for JavaScript projects).**
- If you also work with JS, do the same:
```jsonc
// jsconfig.json
{
"compilerOptions": {
"checkJs": true, // Optional, enables type checking
// other your config...
},
"include": ["src", "types"]
// other your config...
}
```
> βΉοΈ ***Tip:*** *For JS projects, consider adding `"checkJs": true` for better IntelliSense.*
- 6οΈβ£ **Restart your editor/IDE.**
- This forces your TypeScript language service to re-index the package.
- After restart, **all functions, types, and modules from `@rzl-zone/utils-js` will appear instantly in autocomplete**.
---
π₯ Usage
### **Easy to use, just import on your code base.**
#### *Example Function Import:*
```ts
import { isServer } from "@rzl-zone/utils-js/predicates";
console.log(isServer());
// β `true` if running on server-side, `false` if in browser.
```
---
**Help support development:**
*[π **Become a sponsor**](https://github.com/sponsors/rzl-app).*
---
π Changelog
**See [CHANGELOG](https://github.com/rzl-zone/rzl-zone/blob/main/packages/utils-js/CHANGELOG.md).**
---
π€ Contributing
**See [CONTRIBUTING](https://github.com/rzl-zone/rzl-zone/blob/main/CONTRIBUTING.md).**
---
π Security
**Please report issues to [rzlzone.dev@gmail.com](mailto:rzlzone.dev@gmail.com).**
---
π Credits
**- [Rzl App](https://github.com/rzl-app).**
**- [All Contributors](https://github.com/rzl-zone/rzl-zone/graphs/contributors).**
---
π License
**The MIT License (MIT).**
*Please see **[License File](https://github.com/rzl-zone/rzl-zone/blob/main/LICENSE)** for more information.*
---
β
**Enjoy using `@rzl-zone/utils-js`?**
*Star the monorepo [β](https://github.com/rzl-zone/rzl-zone) and share it with other JavaScript developers!*
π¦ Explore other packages under [`@rzl-zone`](https://github.com/rzl-zone/rzl-zone)
---
