# pipe-io

> Pipe streams and handle events

Latest version **4.0.1** (published 2020-04-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install pipe-io
pnpm add pipe-io
yarn add pipe-io
bun add pipe-io
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.1 |
| Published | 2020-04-14 |
| First published | 2014-05-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 0 |
| Unpacked size | 13.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 17 |
| Author | coderaiser |
| Maintainers | coderaiser |
| Keywords | pipe, stream |

## Links

- npm: https://www.npmjs.com/package/pipe-io
- Repository: https://github.com/coderaiser/pipe-io
- Homepage: http://github.com/coderaiser/pipe-io
- Issues: https://github.com/coderaiser/pipe-io/issues
- npm.io page: https://npm.io/package/pipe-io

## Recent versions

- 4.0.1 (latest) — 2020-04-14
- 4.0.0 — 2019-09-17
- 3.0.12 — 2019-09-17
- 3.0.11 — 2018-11-21
- 3.0.10 — 2018-11-14
- 3.0.9 — 2018-10-03
- 3.0.8 — 2018-10-02
- 3.0.7 — 2018-10-02
- 3.0.6 — 2018-09-20
- 3.0.5 — 2018-08-23
- 3.0.4 — 2018-08-16
- 3.0.3 — 2018-05-08
- 3.0.2 — 2018-05-05
- 3.0.1 — 2018-05-02
- 3.0.0 — 2018-05-02
- … 63 more at https://npm.io/package/pipe-io/versions

## README

Pipe-io [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]
=========
Pipe [streams](https://github.com/substack/stream-handbook) and handle events.

## Install

```
npm i pipe-io
```

## API

### pipe
Create pipe between streams and adds callback wich would 
be called once whenever everything is done, or error occures.

```js
const fs = require('fs');

const pipe = require('pipe-io');
const tryToCatch = require('try-to-catch');

const NAME = 'README.md';
const NAME2 = 'README2.md';
const readStream = fs.createReadStream(NAME);
const writeStream = fs.createWriteStream(NAME2);

const [e] = await tryToCatch(pipe, [readStream, writeStream]);
```

## Related

- [Pullout](https://github.com/coderaiser/pullout "Pullout") - pull out data from stream

## License
MIT

[NPMIMGURL]:                https://img.shields.io/npm/v/pipe-io.svg?style=flat
[BuildStatusIMGURL]:        https://img.shields.io/travis/coderaiser/pipe-io/master.svg?style=flat
[DependencyStatusIMGURL]:   https://img.shields.io/david/coderaiser/pipe-io.svg?style=flat
[LicenseIMGURL]:            https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
[CoverageIMGURL]:           https://coveralls.io/repos/coderaiser/pipe-io/badge.svg?branch=master&service=github
[NPMURL]:                   https://npmjs.org/package/pipe-io "npm"
[BuildStatusURL]:           https://travis-ci.org/coderaiser/pipe-io  "Build Status"
[DependencyStatusURL]:      https://david-dm.org/coderaiser/pipe-io "Dependency Status"
[LicenseURL]:               https://tldrlegal.com/license/mit-license "MIT License"
[CoverageURL]:              https://coveralls.io/github/coderaiser/pipe-io?branch=master

---
_Source: https://npm.io/package/pipe-io · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._