# minipass-pipeline

> create a pipeline of streams using Minipass

Latest version **3.0.1** (published 2026-06-08) · BlueOak-1.0.0 license · 0 weekly downloads

## Install

```sh
npm install minipass-pipeline
pnpm add minipass-pipeline
yarn add minipass-pipeline
bun add minipass-pipeline
```

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2026-06-08 |
| First published | 2019-09-15 |
| Weekly downloads | 0 |
| License | BlueOak-1.0.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18 |
| Dependencies | 1 |
| Unpacked size | 40.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Isaac Z. Schlueter |
| Maintainers | isaacs |

## Links

- npm: https://www.npmjs.com/package/minipass-pipeline
- Repository: https://github.com/isaacs/minipass-pipeline
- Homepage: https://github.com/isaacs/minipass-pipeline#readme
- Issues: https://github.com/isaacs/minipass-pipeline/issues
- npm.io page: https://npm.io/package/minipass-pipeline

## Dependencies (1)

- [minipass](https://npm.io/package/minipass.md) ^7.1.3

## Recent versions

- 3.0.1 (latest) — 2026-06-08
- 3.0.0 — 2026-03-25
- 2.0.0 — 2026-03-25
- 1.2.4 — 2020-07-28
- 1.2.3 — 2020-05-13
- 1.2.2 — 2019-09-30
- 1.2.1 — 2019-09-26
- 1.2.0 — 2019-09-23
- 1.1.2 — 2019-09-17
- 1.1.1 — 2019-09-16
- 1.1.0 — 2019-09-16
- 1.0.2 — 2019-09-15
- 1.0.1 — 2019-09-15
- 1.0.0 — 2019-09-15

## README

# minipass-pipeline

Create a pipeline of streams using Minipass.

Calls `.pipe()` on all the streams in the list. Returns a stream where
writes got to the first pipe in the chain, and reads are from the last.

Errors are proxied along the chain and emitted on the Pipeline stream.

## USAGE

```js
const Pipeline = require('minipass-pipeline')

// the list of streams to pipeline together,
// a bit like `input | transform | output` in bash
const p = new Pipeline(input, transform, output)

p.write('foo') // writes to input
p.on('data', chunk => doSomething()) // reads from output stream

// less contrived example (but still pretty contrived)...
const decode = new bunzipDecoder()
const unpack = tar.extract({ cwd: 'target-dir' })
const tbz = new Pipeline(decode, unpack)

fs.createReadStream('archive.tbz').pipe(tbz)

// specify any minipass options if you like, as the first argument
// it'll only try to pipeline event emitters with a .pipe() method
const p = new Pipeline({ objectMode: true }, input, transform, output)

// If you don't know the things to pipe in right away, that's fine.
// use p.push(stream) to add to the end, or p.unshift(stream) to the front
const databaseDecoderStreamDoohickey = connectionInfo => {
  const p = new Pipeline()
  logIntoDatabase(connectionInfo).then(connection => {
    initializeDecoderRing(connectionInfo).then(decoderRing => {
      p.push(connection, decoderRing)
      getUpstreamSource(upstream => {
        p.unshift(upstream)
      })
    })
  })
  // return to caller right away
  // emitted data will be upstream -> connection -> decoderRing pipeline
  return p
}
```

Pipeline is a [minipass](http://npm.im/minipass) stream, so it's as
synchronous as the streams it wraps. It will buffer data until there is a
reader, but no longer, so make sure to attach your listeners before you
pipe it somewhere else.

## `new Pipeline(opts = {}, ...streams)`

Create a new Pipeline with the specified Minipass options and any streams
provided.

## `pipeline.push(stream, ...)`

Attach one or more streams to the pipeline at the end (read) side of the
pipe chain.

## `pipeline.unshift(stream, ...)`

Attach one or more streams to the pipeline at the start (write) side of the
pipe chain.

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