Skip to content

helderberto/maximus

Repository files navigation

⚔️ Maximus

Lightweight functional JavaScript utilities

The acronym "MXS" is used in this project to refer to the package name "Maximus"

InstallDocumentationContribute

Maximus Banner

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 mxs

In 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.

License

MIT License © Maximus