@extremejs/utils

Modern TypeScript utilities inspired by lodash,
aiming to be high performance while having minimal size impact.


Table of Content

- Installation
- NPM
- PNPM
- Yarn
- Usage
- Notes
- Versioning
- Authors
- License

Installation

$3

``shell
npm i @extremejs/utils
`

$3

`shell
pnpm add @extremejs/utils
`

$3

`shell
yarn add @extremejs/utils
`

Usage

`typescript
import { sumByFn } from "@extremejs/utils";
// or
import { sumByFn } from "@extremejs/utils/sum-by-fn";

const sum = sumByFn([{ a: 1 }, { a: 2 }, { a: 3 }], ({ a }) => a);
`

> API usage documents are available here.

$3

1. Although this package is inspired by lodash,
the method names might not be exactly the same or have different usage API,
so make sure to read the docs first before using it.
2. The methods do not type check at runtime
(e.g. The Array chunk method assumes the size parameter is always a valid positive integer)
so make sure you pass the correct values based on the documents/typescript` types.

Versioning

We use SemVer for versioning.
For the versions available, see the releases on this repository.

Authors

- Ardalan Amini - _Core Maintainer_ - @ardalanamini

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.