https://github.com/barelyhuman/pipe

An adaptable and tiny pipe utility
https://github.com/barelyhuman/pipe

async functional javascript pipe utility

Last synced: 22 days ago
JSON representation

An adaptable and tiny pipe utility

• Host: GitHub
• URL: https://github.com/barelyhuman/pipe
• Owner: barelyhuman
• License: mit
• Created: 2023-01-29T01:29:46.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T05:56:45.000Z (over 1 year ago)
• Last Synced: 2024-10-02T08:44:55.595Z (about 1 month ago)
• Topics: async, functional, javascript, pipe, utility
• Language: TypeScript
• Homepage:
• Size: 135 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @barelyhuman/pipe

A tiny pipe utility

![npm](https://img.shields.io/npm/v/@barelyhuman/pipe?colorA=black&colorB=black&logoColor=black)

## Why?

Tired of copying it around

## Highlights

- Tiny API

- Clonable

- Lazy Execution

- Plugins

## Usage

The util was built to abstract async manipulation from the actual flow and make

it look cleaner when working with arrays

This is primarily for dealing with nested function calls and hiding the async

logic

Eg:

```js

const value = await Promise.all(something.map(id => fetchById(id)))

// Could be written as

// before v0.2.3

const value = await pipe(something)

  .map(id => fetchById(id))

  .to(x => Promise.all(x))

  .run()

// from v0.2.3

const value = await pipe(something)

  .map(id => fetchById(id))

  .run()

// or if you don't like magic then, but at this point

// there's no difference between this and the original

// statement

const value = await pipe(something)

  .to(previous => previous.map(id => fetchById(id)))

  .to(x => Promise.all(x))

  .run()

```

### Clonable

The pipes are clonable and each have their own scope

A very simple example would be

Eg:

```js

const basePipe = pipe(1).to(x => x * 2)

const nextPipe = pipe(basePipe).to(x => x * 3)

const valTwo = await nextPipe.run() // 6

const valOne = await basePipe.run() // 2

```

### Lazy Execution

As shown in the examples the actual execution of the given data isn't started

unless `.run` is triggered. This makes it easier to transfer context around if

needed and in a defined sequence, also makes it easier to extend.

### Plugins

You can read about them in [PLUGINS.md](/PLUGINS.md)

[MIT](/LICENSE)