https://github.com/justinvdm/pipe-with

(type-aware) utility function for defining how a pipeline of functions should be composed
https://github.com/justinvdm/pipe-with

compose flowtype monads pipe

Last synced: 10 days ago
JSON representation

(type-aware) utility function for defining how a pipeline of functions should be composed

• Host: GitHub
• URL: https://github.com/justinvdm/pipe-with
• Owner: justinvdm
• License: mit
• Created: 2018-02-11T14:49:38.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-04-25T00:03:25.000Z (over 2 years ago)
• Last Synced: 2024-09-22T08:36:10.877Z (about 2 months ago)
• Topics: compose, flowtype, monads, pipe
• Language: JavaScript
• Homepage:
• Size: 2.15 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: readme.md
  • Changelog: CHANGELOG.md
  • License: license

Awesome Lists containing this project

README

        
# pipe-with

[![Build Status](https://travis-ci.org/justinvdm/pipe-with.svg?branch=master)](https://travis-ci.org/justinvdm/pipe-with)

(type-aware) utility function for defining how a pipeline of functions should be composed

```js

const pipe = pipeWith(fn => ma => ma.then(fn))

const fn = pipe(

  v => Promise.resolve(v + 1),

  v => Promise.resolve(v * 2))

fn(23).then(console.log)  // 48

```

## important note for type definitions

When using this library with flow or typescript, there is a limit of 16 arguments for `pipe` functions.

## api

### `pipeWith(bindFn)`

Takes in a bind function and returns a corresponding pipe function. The pipe function composes the functions passed to it from left to right, but processes the result of each function call using the bind function. The bind function should have a type signature of `(a -> m b) -> (m a -> m b)`.

For example, if we wanted to compose promise-returning functions, `bindFn` could look like this:

```js

const bind = (fn: A => Promise): ((Promise) => Promise) =>

  ma => ma.then(fn)

```


### `pipe([...fns])`

Composes the given functions from left to right. For e.g. `pipe(fn1, fn2)(v)` would return the same result as `fn2(fn1(v))`.

## install

You can use this library as the npm package `pipe-with`:

```

npm i pipe-with

# or

yarn add pipe-with

```

It can be used in both es-module-aware and commonjs bundlers/environments.

```js

// es module

import { pipeWith } from 'pipe-with'

// commonjs

const { pipeWith } = require('pipe-with')

```

It can also be used a ``:

```html

<script

  crossorigin

  src="https://unpkg.com/pipe-with/dist/umd/pipe-with.js"

>

pipeWith(...)

```