Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davguij/utilist
A modern utility library for JavaScript and TypeScript.
https://github.com/davguij/utilist
javascript library lodash modules stdlib typescript utilities utility utils zero-dependency
Last synced: 2 days ago
JSON representation
A modern utility library for JavaScript and TypeScript.
- Host: GitHub
- URL: https://github.com/davguij/utilist
- Owner: davguij
- License: mit
- Created: 2020-06-15T12:35:41.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-13T02:29:16.000Z (about 2 years ago)
- Last Synced: 2024-12-09T21:19:46.768Z (about 2 months ago)
- Topics: javascript, library, lodash, modules, stdlib, typescript, utilities, utility, utils, zero-dependency
- Language: TypeScript
- Homepage: https://davguij.github.io/utilist/
- Size: 1.76 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# utilist
   [](https://codecov.io/gh/davguij/utilist)
A modern utility library for JavaScript and TypeScript, both for the browser and for Node.js, that helps you solve routine tasks and common problems in a fast way, therefore letting you focus on what matters (building awesome stuff!)
## Why **utilist**
**utilist** is the spiritual successor of Underscore and Lodash, but it has been built in a time when ES6+ and the latest versions of the evergreen browsers and Node.js have effectively made redundant quite a big part of the functionality of those libraries.
With this in mind, **utilist** is:
- **lean**, as it only implements utilities that are still useful in the present times.
- **performant**, because it's modular and tree-shakeable, so you only add to your bundle those bytes that you're actually using.
- **reliable and safe**, for it's built without any external dependencies, and fully written in TypeScript.
## Installation
**Using npm**
`npm install utilist`
**Using yarn**
`yarn add utilist`
## Usage
**utilist** is exported in both CommonJS and ESM formats. This means you can import it with both `require` (mostly for Node.js environments) and `import` syntaxes.
### Example
```typescript
import { shuffle } from 'utilist'; // shuffles an array
shuffle([1, 2, 3, 4, 5]); // returns [2, 5, 3, 4, 1]
```
### List of methods
- `chunk()` — Creates an array of elements split into subarrays the length of `size`. [See documentation.](https://davguij.github.io/utilist/modules/_difference_.html)
- `difference()` — Takes two arrays and returns the difference between them as a new array. [See documentation.](https://davguij.github.io/utilist/modules/_difference_.html)
- `filterByValue()` — Filters an object by its values. [See documentation.](https://davguij.github.io/utilist/modules/_filter_object_.html)
- `isDate()` — Assesses if the input is of the type Date. [See documentation.](https://davguij.github.io/utilist/modules/_is_date_.html)
- `isEqual()` — Compares two objects and returns whether their values are equivalent. [See documentation.](https://davguij.github.io/utilist/modules/_is_equal_.html)
- `mapValues()` — Like `map()` but applied to the values of an object. [See documentation.](https://davguij.github.io/utilist/modules/_map_values_.html)
- `occurrences()` — Counts the number of times that a substring appears in a string. [See documentation.](https://davguij.github.io/utilist/modules/_occurrences_.html)
- `omit()` — Removes a list of properties from an object. [See documentation.](https://davguij.github.io/utilist/modules/_omit_.html)
- `random()` — Generates a random integer between a minimum and a maximum. [See documentation.](https://davguij.github.io/utilist/modules/_random_.html)
- `sample()` and `sampleOne()` — Return one or more random elements from an array. [See documentation.](https://davguij.github.io/utilist/modules/_sample_.html)
- `shuffle()` — Shuffles an array. [See documentation.](https://davguij.github.io/utilist/modules/_shuffle_.html)