/js-extra

Does what native Javascript doesn't.

Primary LanguageTypeScriptMIT LicenseMIT

js-extra

npm version GitHub license PRs Welcome

Does what native Javascript doesn't.

js-extra docs

Motivation

From my humble point of view, Javascript is lacking of some very useful small built-in functions some other languages, like Python, have.

Yes, reduce and map can do quite a lot of things, in quite a lot of situations. They can also often save us in the most desparate situations. But because they are very generic tools, they do not provide a clear straight-forward understanding of what they are used/implemented for.

For example, let's say you want to count the occurences of a number in an array of numbers. For sure, you can do it with a reduce:

array.reduce((count, item) => item === itemToCount ? count + 1 : count, 0)

But let's be honest. Don't you think this is so verbose code for a simple count() ? Why is there not a built-in count function in Javascript ?

This is exactly what js-extra is built for. Its aim is to provide explicit functions built on top of the native Javascript functions. Since Lodash already provides many extra functions, the lib will aim to complete it with very specific functions.

How to use js-extra

Yarn:

$ yarn add js-extra

Npm:

$ npm i js-extra

You can import the functions this way:

ES6

import { count } from 'js-extra'

ES5

var count = require('js-extra').count

You can find all the implemented & available functions of the lib here

Contributing

Any contribution would be more than welcome! You think you can optimize the algorithms of existing functions ? Please, open a PR! :)

You would like to add a function that Javascript doesn't have natively ? Please, go ahead and open a PR! :)

Found any bugs or you have some ideas ? Please, open an issue! :)

Installation

yarn install

To build the project:

yarn build

To run the tests:

yarn test

Before you commit:

yarn lint && yarn prettier