# @k88/pipe-compose
> ES6 pipe and compose in JavScript
Latest version **2.5.0** (published 2021-08-12) · ISC license · 0 weekly downloads
## Install
```sh
npm install @k88/pipe-compose
pnpm add @k88/pipe-compose
yarn add @k88/pipe-compose
bun add @k88/pipe-compose
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.5.0 |
| Published | 2021-08-12 |
| First published | 2019-07-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 24.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kousha Talebian |
| Maintainers | ktalebian |
## Links
- npm: https://www.npmjs.com/package/@k88/pipe-compose
- Repository: https://github.com/ktalebian/pipe-compose
- Homepage: https://github.com/ktalebian/pipe-compose#readme
- Issues: https://github.com/ktalebian/pipe-compose/issues
- npm.io page: https://npm.io/package/@k88/pipe-compose
## Recent versions
- 2.5.0 (latest) — 2021-08-12
- 2.4.3 — 2021-03-05
- 2.4.2 — 2021-01-11
- 2.4.1 — 2021-01-10
- 2.1.2 — 2020-07-19
- 2.2.0 — 2020-04-03
- 2.1.1 — 2019-07-24
- 2.1.0 — 2019-07-14
- 2.0.0 — 2019-07-14
- 1.2.1 — 2019-07-12
- 1.1.1 — 2019-07-12
- 1.1.0 — 2019-07-12
- 1.0.0 — 2019-07-11
## README
@k88/pipe-compose
ES6-like pipe, compose, p-pipe, and p-compose in JavaScript, inspired by this Medium post.
## What is it?
This library exports 6 functions: `pipe`, `compose`, `cPipe`, `cCompose`, `pPipe`, and `pCompose`.
### Pipe and Compose
To paraphrase the Medium post, image you want to pipe the output of n-functions together. You'll end up with something like:
```js
reverse(get3Chars(uppercase('the-argument')));
// EHT
```
In this example, you first `uppercase` to get `THE-ARGUMENT`, then you `get3Chars` and have `THE` and finally you `reverse` it to get `EHT`.
With `pipe` you can accomplish the same thing using:
```js
pipe('the-argument', uppercase, get3Chars, reverse);
```
It helps to read this similar to bash's pipe `|`:
```bash
echo 'the-argument' | uppercase | get3Chars | reverse;
```
`compose` is the reverse of `pipe`. For example these two would return the same result.
```js
pipe('the-argument', uppercase, get3Chars, reverse);
compose('the-argument', reverse, get3Chars, uppercase);
```
### cPipe and cCompose
These are composable versions of `pipe` and `compose`, i.e.:
```js
const textModifier = cPipe(uppercase, get3Chars, reverse);
textModifier('the-argument');
// EHT
textModifier('another-argument');
// ONA
```
### pPipe and pCompose
There are also composable promise version of the pipe and compose.
```js
const calc = pPipe(add1, multiply2, divide3);
await calc(2);
// 2
```
In this example, we are creating a calculation function that takes in an number, and performs basic math operation on it. In this case, we are passing `2` and first adding 1 to it (giving us 3), then multiplying by 2 (giving us 6) and finally dividing by 3 (giving us back 2).
As before, `pCompose` would work in the reverse:
```js
const calc = pCompose(add1, multiply2, divide3);
await calc(6);
// 5
```
## How to use it
### Installing NPM package
Install from npm:
```bash
npm install @k88/pipe-compose
```
and use it:
```js
import { pipe, compose } from '@k88/pipe-compose';
```
### Get the source code
All of these auxiliary functions are one-liner, so you can also just copy/paste them into your application:
```js
const pipe = (x, ...fns) => fns.reduce((v, f) => f(v), x);
const compose = (x, ...fns) => fns.reduceRight((v, f) => f(v), x);
const cPipe = (...fns) => (x) => => fns.reduce((v, f) => f(v), x);
const cCompose = (...fns) => (x) => fns.reduceRight((v, f) => f(v), x);
const pPipe = (...fns) => async (x) => fns.reduce(async (v, f) => f(await v), x);
const pCompose = (...fns) => async (x) => fns.reduceRight(async (v, f) => f(await v), x);
```
---
_Source: https://npm.io/package/@k88/pipe-compose · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._