https://github.com/afeiship/pipe
Pipe is a lightweight JavaScript library for function composition and execution.
https://github.com/afeiship/pipe
compose fn pipe pipe-async pipe-sync
Last synced: about 1 month ago
JSON representation
Pipe is a lightweight JavaScript library for function composition and execution.
- Host: GitHub
- URL: https://github.com/afeiship/pipe
- Owner: afeiship
- License: mit
- Created: 2019-08-25T00:58:00.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-07-10T00:52:26.000Z (11 months ago)
- Last Synced: 2025-07-10T10:10:26.902Z (11 months ago)
- Topics: compose, fn, pipe, pipe-async, pipe-sync
- Language: TypeScript
- Homepage:
- Size: 468 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# pipe
> Pipe is a lightweight JavaScript library for function composition and execution.
[![version][version-image]][version-url]
[![license][license-image]][license-url]
[![size][size-image]][size-url]
[![download][download-image]][download-url]
## installation
```shell
npm install @jswork/pipe
```
## methods
- [x] pipe === pipe.sync
- [x] pipe.sync (default)
- [x] pipe.async
## usage
```js
import pipe from '@jswork/pipe';
// fns
function addOne(n: number): number {
return n + 1;
}
function double(n: number): number {
return n * 2;
}
function divide(n: number): number {
if (n === 0) {
throw new Error('Divide by zero error.');
}
return 10 / n;
}
// use pipe
const calculate = pipe(
addOne,
double,
divide,
addOne
);
const result1 = calculate(3);
const result2 = calculate(-1);
// has result, without log
console.log('Result1:', result1); // 10 / (3 + 1)*2 + 1 = 2.25
// has result, but with warning log
console.log('Result2:', result2); // 10 / (-1+1)*2 + 1 => Throw error: Divide by zero error.
```
## pipe vs compose
- compose：常见于函数式编程库如 Redux、Ramda，因为其与数学定义一致。
- pipe：常见于像 Elm、F# 或者 RxJS 中，因为它更符合“先做什么，再做什么”的自然阅读顺序。
## license
Code released under [the MIT license](https://github.com/afeiship/pipe/blob/master/LICENSE.txt).
[version-image]: https://img.shields.io/npm/v/@jswork/pipe
[version-url]: https://npmjs.org/package/@jswork/pipe
[license-image]: https://img.shields.io/npm/l/@jswork/pipe
[license-url]: https://github.com/afeiship/pipe/blob/master/LICENSE.txt
[size-image]: https://img.shields.io/bundlephobia/minzip/@jswork/pipe
[size-url]: https://github.com/afeiship/pipe/blob/master/dist/pipe.min.js
[download-image]: https://img.shields.io/npm/dm/@jswork/pipe
[download-url]: https://www.npmjs.com/package/@jswork/pipe