@keload/node-red-contrib-ultimate-toolkit/README.md

A collection of (moderns) useful tools for Node-RED

# node-red-contrib-ultimate-toolkit

A collection of utilities to help you build your Node-RED flows.

<br/>
<p align="center">
  <a href="https://www.npmjs.com/package/@keload/node-red-dxp" aria-label="Build with node-red-dxp">
    <img src="https://img.shields.io/badge/Build%20with-node--red--dxp-blue?style=for-the-badge" alt="Build with node-red-dxp">
  </a>
</p>
<p align="center">
    <a href="https://github.com/clement-berard/node-red-contrib-ultimate-toolkit/graphs/contributors">
        <img src="https://img.shields.io/github/contributors/clement-berard/node-red-contrib-ultimate-toolkit.svg?style=for-the-badge" alt="Contributors">
    </a>
    <a href="https://github.com/clement-berard/node-red-contrib-ultimate-toolkit/network/members">
        <img src="https://img.shields.io/github/forks/clement-berard/node-red-contrib-ultimate-toolkit.svg?style=for-the-badge" alt="Forks">
    </a>
    <a href="https://github.com/clement-berard/node-red-contrib-ultimate-toolkit/stargazers">
        <img src="https://img.shields.io/github/stars/clement-berard/node-red-contrib-ultimate-toolkit.svg?style=for-the-badge" alt="Stargazers">
    </a>
    <a href="https://github.com/clement-berard/node-red-contrib-ultimate-toolkit/issues">
        <img src="https://img.shields.io/github/issues/clement-berard/node-red-contrib-ultimate-toolkit.svg?style=for-the-badge" alt="Issues">
    </a>
</p>
<p align="center">
  <a aria-label="NPM Version" href="https://www.npmjs.com/package/@keload/node-red-contrib-ultimate-toolkit">
    <img alt="NPM Version" src="https://img.shields.io/npm/v/@keload/node-red-contrib-ultimate-toolkit.svg?label=NPM&logo=npm&style=for-the-badge&color=0470FF&logoColor=white">
  </a>
  <a aria-label="NPM Download Count" href="https://www.npmjs.com/package/@keload/node-red-contrib-ultimate-toolkit">
    <img alt="NPM Downloads" src="https://img.shields.io/npm/dt/@keload/node-red-contrib-ultimate-toolkit?label=Downloads&style=for-the-badge&color=67ACF3">
  </a>
</p>

## Overview 🔦

✨ Simplify and optimize your Node-RED flows with this versatile package! ✨

Effortlessly handle date formatting, math operations, data manipulation, and more—all **in a single node.**

When needed, the following libraries were used sparingly:
- [es-toolkit](https://es-toolkit.slash.page/)
- [radash](https://radash-docs.vercel.app/docs/getting-started)
- [tempo](https://tempo.formkit.com/)

Whenever possible, native Node.js methods take precedence for maximum efficiency.

**One node to rule them all—streamline your flows like never before!**

![paring-config.png](docs/screenshot.png)

## Performance 🚀

All used libraries are treeshaked and included in the final bundle. 

**No extra dependencies are added**

[Very small distribution](https://www.npmjs.com/package/@keload/node-red-contrib-ultimate-toolkit?activeTab=code) **size < 45kb**.

## Features ✨



### → Array Utilities

<hr>

― `Get Random Item` 

 

― `Group By` 

 

― `Key By` 

 

― `Shuffle` 

 

― `Take` 

 

― `Take Right` 

 

― `Toggle` 

 

― `Unique` 

 

### → Async Utilities

<hr>

― `Delay` 

 Delays the message by the specified amount of time

### → Date Utilities

<hr>

― `Current Timezone` 

 Returns the current timezone

― `Format` 

 Return formatted date from a date

― `Now` 

 Returns the current date with lot of formatting options

― `Time Range` 

 Routes messages depending on the time

### → Math Utilities

<hr>

― `Abs` 

 

― `Acos` 

 

― `Asin` 

 

― `Atan` 

 

― `Ceil` 

 

― `Cos` 

 

― `Exp` 

 

― `Floor` 

 

― `Log` 

 

― `Max` 

 

― `Mean` 

 

― `Median` 

 

― `Min` 

 

― `Random` 

 

― `Round` 

 

― `Sin` 

 

― `Sum` 

 

― `Tan` 

 

― `Trunc` 

 

### → Network Utilities

<hr>

― `Ip Information` 

 Fetches detailed information about an IP address

― `Ip Version` 

 Returns IP version (4, 6, or 0 if invalid) for a given IP address string

― `Network Interfaces` 

 Lists all network interfaces of the current machine (ethernet, wifi, etc.)

### → Object Utilities

<hr>

― `Get Keys` 

 

### → Predicates

<hr>

― `Is Boolean` 

 

― `Is Buffer` 

 

― `Is Ip` 

 

― `Is Na N` 

 

― `Is Nil` 

 

― `Is Null` 

 

― `Is Number` 

 

― `Is String` 

 

― `Is Undefined` 

 

― `Is Url` 

 

### → String Utilities

<hr>

― `Camel Case` 

 

― `Capitalize` 

 

― `Constant Case` 

 

― `Escape` 

 

― `Kebab Case` 

 

― `Lower Case` 

 

― `Lower First` 

 

― `Pascal Case` 

 

― `Snake Case` 

 

― `Start Case` 

 

― `Trim` 

 

― `Trim End` 

 

― `Trim Start` 

 

― `Unescape` 

 

― `Upper Case` 

 

― `Upper First` 

 

― `Words` 

 

### → Tools

<hr>

― `Cyclic Counter` 

 A customizable cyclic counter node for Node-RED that iterates through a defined sequence of numbers and can reset after a set timeout. It allows flexible control over the counter's behavior, making it useful in a variety of automation scenarios.

### → Utility Functions

<hr>

― `Eq` 

 

― `Gt` 

 

― `Gte` 

 

― `Lt` 

 

― `Lte` 

 

― `Size` 

 

― `To Boolean` 

 

― `To Boolean Number` 

 

― `To Number` 

 

― `To Number Non Strict` 

 

― `To Safe Integer` 

 

― `To String` 

 


## Contributing & Developer Experience
This package is built using [node-red-dxp](https://www.npmjs.com/package/@keload/node-red-dxp), offering a blazing-fast and seamless way to develop Node-RED packages. 

Written in **TypeScript**, the codebase is cleanly structured, ensuring maintainability and effortless scalability.

We’re committed to keeping this node alive and thriving, making it a joy to evolve and improve over time. Whether it's refining existing features or adding new capabilities, contributing should always be an enjoyable experience.

Feel free to join the journey—create issues, submit pull requests, or share your ideas. Let’s build something incredible together!

## License

MIT