xen-orchestra/@vates/compose
2021-04-07 13:36:24 +02:00
..
index.js feat(compose): forwards this to all functions 2021-02-22 14:42:18 +01:00
index.spec.js feat(compose): forwards this to all functions 2021-02-22 14:42:18 +01:00
package.json feat(@vates/compose): 2.0.0 2021-02-22 14:42:45 +01:00
README.md fix(compose/USAGE): typo 2021-04-07 13:36:24 +02:00
USAGE.md fix(compose/USAGE): typo 2021-04-07 13:36:24 +02:00

@vates/compose

Package Version License PackagePhobia Node compatibility

Compose functions from left to right

Install

Installation of the npm package:

> npm install --save @vates/compose

Usage

import { compose } from '@vates/compose'

const add2 = x => x + 2
const mul3 = x => x * 3

// const f = x => mul3(add2(x))
const f = compose(add2, mul3)

console.log(f(5))
// → 21

The call context (this) of the composed function is forwarded to all functions.

The first function is called with all arguments of the composed function:

const add = (x, y) => x + y
const mul3 = x => x * 3

// const f = (x, y) => mul3(add(x, y))
const f = compose(add, mul3)

console.log(f(4, 5))
// → 27

Functions may also be passed in an array:

const f = compose([add2, mul3])

Options can be passed as first parameter:

const f = compose(
  {
    // compose async functions
    async: true,

    // compose from right to left
    right: true,
  },
  [add2, mul3]
)

Contributions

Contributions are very welcomed, either on the documentation or on the code.

You may:

  • report any issue you've encountered;
  • fork and create a pull request.

License

ISC © Vates SAS