⚔️ Maximus
Lightweight functional JavaScript utilities
The acronym "MXS" is used in this project to refer to the package name "Maximus"
Install • Documentation • Contribute
<a style="margin: 0 2px;" href="https://github.com/helderburato/maximus/actions/workflows/ci.yml">
<img src="https://github.com/helderburato/maximus/actions/workflows/ci.yml/badge.svg" alt="ci badge">
</a>
<a style="margin: 0 2px;" href="https://npmjs.com/package/mxs">
<img src="https://img.shields.io/npm/v/mxs.svg" alt="version badge">
</a>
<a style="margin: 0 2px;" href="http://www.npmtrends.com/mxs">
<img src="https://img.shields.io/npm/dm/mxs.svg" alt="downloads package badge">
</a>
<a style="margin: 0 2px;" href="https://github.com/helderburato/maximus/blob/main/LICENSE">
<img src="https://img.shields.io/npm/l/maximus.svg" alt="maximus license">
</a>
<a style="margin: 0 2px;" href="http://standardjs.com">
<img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg" alt="js-standard-style">
</a>
Why Maximus?
We noticed that there are several packages that provide functionalities using functional programming, the Maximus objective is not to overlay robust tools like Ramda and Lodash, but for cases where you don't need everything that is offered in these great and appreciated packages.Some utilities are repeated in the projects we work on and are commonly necessary to rewrite or copy-paste.
Based on this, we aim to focus on small utilities to facilitate the use of functional approach, manipulation of Arrays and Objects.
Install
Using NPM or Yarn:$ npm i --save mxs OR yarn add mxsIn Node.js:
const MXS = require('mxs)Directly in the browser:
<script src="path/to/your/mxs.js"></script>Usage
import * as MXS from 'mxs';
const result = MXS.compose(
(withMiddleName) => `${withMiddleName} Meridius`,
(name) => `${name} Décimus`,
)('Maximus');
console.log(result); // => 'Maximus Décimus Meridius'Contribute
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.Please make sure to update tests as appropriate.
