# fump
> Useful collection of functional composition helper functions
Latest version **1.0.0** (published 2017-06-04) · MIT license · 0 weekly downloads
## Install
```sh
npm install fump
pnpm add fump
yarn add fump
bun add fump
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-06-04 |
| First published | 2017-06-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Tiaan du Plessis |
| Maintainers | tiaanduplessis |
| Keywords | functions, helpers, utilities, composition, curry, decoupled, map, flatMap, fump |
## Links
- npm: https://www.npmjs.com/package/fump
- Repository: https://github.com/tiaanduplessis/fump
- Issues: https://github.com/tiaanduplessis/fump/issues
- npm.io page: https://npm.io/package/fump
## Alternatives
- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads
## Recent versions
- 1.0.0 (latest) — 2017-06-04
## README
𝝺 fump
Useful collection of functional composition helper functions
Table of Contents
Table of Contents
Install
Usage
API
Learning
Contribute
License
## Install
```sh
$ npm install fump
# OR
$ yarn add fump
```
## Usage
```js
import {
compose,
pipe,
map,
filter,
reduce,
curry,
flatMap
} from 'fump'
// Do some magic
```
## API
### `.compose(functions)`
The function accepts one or more functions that are applied from **right to left** on a initial value. It Returns a function that accepts the initial value.
```js
const addFive = (a) => a + 5
const timesTwo = (a) => a * 2
const timesAndAdd = compose(addFive, timesTwo) // => Function
timesAndAdd(10) // => 25
```
### `.pipe`
The function provides the same functionality as the `compose` function, but the functions are applied to the initial value from **left to right**.
### `.map`
Function provides similar functionality to the [`Array.prototype.map()`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/map). It accepts a function as its argument and returns a function that accepts a object or array to map over.
```js
const timesTwo = x => x * 2
const arr = [1, 2, 3, 4]
map(timesTwo)(arr) // => [2, 4, 6, 8]
const addOne = x => x + 1
const obj = {
0: 1,
1: 2,
2: 3,
length: 3
}
map(addOne)(obj) // => [ 2, 3, 4 ]
```
### `.filter`
Function provides similar functionality to the [`Array.prototype.filter()`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/filter). It accepts a predicate function as its argument and returns a function that accepts a object or array to filter.
```js
const moreThanTwo = x => x > 2
const arr = [1, 2, 3, 4]
filter(moreThanTwo)(arr) // => [ 3, 4 ]
const isEven = x => x % 2 === 0
const obj = {
0: 1,
1: 2,
2: 3,
3: 4,
length: 4
}
filter(isEven)(obj) // => [ 2, 4 ]
```
### `.reduce`
Function provides similar functionality to the [`Array.prototype.reduce()`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce). It accepts a function as its argument and returns a function that accepts a object or array to reduce.
```js
const add = (a, b) => a + b
const sum = reduce(add)
sum([1, 2, 3]) // => 6
```
### `.flatMap`
Function provides similar functionality to `map`, but flattens any of the callbacks returns.
```js
const fill = flatMap(x => new Array(x).fill(x))
fill([1, 2, 3]) // => [ 1, 2, 2, 3, 3, 3 ]
```
### `.curry`
See [learning](#Learning) section for more information about currying.
```js
const add = (a, b) => a + b
const addOne = curry(add)(1)
addOne(5) // => 6
```
## Learning
### Articles
- [Functional JavaScript: Decoupling methods from their objects](https://hackernoon.com/functional-javascript-decoupling-methods-from-their-objects-aa3ca13d7ae8)
- [Currying & Partial Application](https://medium.com/javascript-inside/currying-partial-application-f1365d5fad3f)
- [Why The Hipsters Compose Everything](https://medium.com/javascript-inside/why-the-hipsters-compose-everything-9b0aa247944a)
- [Functional JavaScript: Function Composition For Every Day Use.](https://hackernoon.com/javascript-functional-composition-for-every-day-use-22421ef65a10)
### Books
- [Mostly adequate guide to FP](https://github.com/MostlyAdequate/mostly-adequate-guide)
- [Functional-Light JavaScript](https://github.com/getify/Functional-Light-JS)
## Contribute
Contributions are welcome. Please open up an issue or create PR if you would like to help out.
## License
MIT
---
_Source: https://npm.io/package/fump · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
