moderndash/README.md

A Typescript-First utility library inspired by Lodash. Optimized for modern browsers.

![ModernDash Logo](https://raw.githubusercontent.com/Maggi64/moderndash/main/website/src/assets/moderndashLogo.svg)

<p align=center>
  <b>
    A Typescript-First utility library inspired by Lodash.
    Optimized for modern browsers & developer experience.
  </b>
</p>

<div align=center class="space-y">
  ✅ ESM
  ✅ Fast & Lightweight
  ✅ Tree-shakable
  ✅ Typescript Strict Mode (no any)
  <br>
  ✅ 100% Test Coverage
  ✅ Zero runtime dependencies
  ✅ Hoverable Docs
</div>
<p></p>

<div align=center class="center">
  <a href="https://bundlephobia.com/package/moderndash@latest">
    <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/moderndash@latest?color=Green">
  </a>
  <a href="https://www.npmjs.com/package/moderndash">
    <img alt="npm" src="https://img.shields.io/npm/dm/moderndash">
  </a>
  <a href="https://www.npmjs.com/package/moderndash">
    <img alt="npm" src="https://img.shields.io/npm/v/moderndash?color=blue&label=version">
  </a>
  <span>
    <img alt="node-current" src="https://img.shields.io/node/v/moderndash?color=blue">
  </span>
  <a href="https://github.com/Maggi64/moderndash/blob/main/LICENSE">
    <img alt="GitHub" src="https://img.shields.io/github/license/maggi64/moderndash?color=orange">
  </a>
</div>

<h3 align=center class="hide-on-website">
  <a href="https://moderndash.io/docs/chunk" target="_blank">
       📓 Documentation
  </a>
</h3>

---

<div align=center class="space-y">
  <img alt="Intro Code" width=100% src="https://raw.githubusercontent.com/Maggi64/moderndash/main/website/src/assets/introCodeV6.svg"></img>
</div>

## 💾 Installation

```bash
npm install moderndash
```
## 📋 Requirements

**NodeJS**: >=20.x | **Typescript**: >=5.0

## 🚀 Performance

ModernDash aims to outperform Lodash and deliver lightning-fast utility functions. Performance is not an afterthought, but a top priority. You can expect ModernDash to exceed or at least match the performance of Lodash in most benchmarks, ensuring that your project stays speedy and efficient.

**[[ Benchmark Results](https://github.com/Maggi64/moderndash/blob/main/benchmark/RESULTS.md) ]**

## 🗃 FAQ

### Why is X lodash function not included?
ModernDash does not include any lodash functions that can be easily replaced by native javascript. It only includes the functions that you really need, and keeps the library as slim as possible.
Please refer to [You-Dont-Need-Lodash](https://github.com/you-dont-need/You-Dont-Need-Lodash-Underscore) or [youmightnotneed.com/lodash](https://youmightnotneed.com/lodash) for native replacements.  
If you still believe a function is missing, please open an issue.

## 💌 Love & Thanks

To [type-fest](https://github.com/sindresorhus/type-fest) for providing some valuable types.

## 🧰 Contribute

- Star the repo if you like it

- Check the [contributing](https://github.com/Maggi64/moderndash/blob/main/CONTRIBUTING.md) section!