# pull-abortable

> a pull-stream which may be aborted

Latest version **4.1.1** (published 2017-04-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install pull-abortable
pnpm add pull-abortable
yarn add pull-abortable
bun add pull-abortable
```

## 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.1.1 |
| Published | 2017-04-16 |
| First published | 2014-12-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Dominic Tarr |
| Maintainers | dominictarr |

## Links

- npm: https://www.npmjs.com/package/pull-abortable
- Repository: https://github.com/dominictarr/pull-abortable
- Issues: https://github.com/dominictarr/pull-abortable/issues
- npm.io page: https://npm.io/package/pull-abortable

## Recent versions

- 4.1.1 (latest) — 2017-04-16
- 4.1.0 — 2015-06-15
- 4.0.0 — 2014-12-10
- 3.0.0 — 2014-12-10
- 2.0.0 — 2014-12-07
- 1.1.1 — 2014-12-05
- 1.1.0 — 2014-12-05
- 1.0.0 — 2014-12-05

## README

# pull-abortable

a pull-stream that may be aborted from the outside.

# example

``` js
var pull = require('pull-stream')
var Abortable = require('pull-abortable')

var abortable = Abortable()
pull(
  source,
  abortable,
  sink
)
//at any time you can abort the pipeline,
//the source will be cleaned up, and any
//error will be passed to the sink next time it reads.
atAnyTime(function () {
  abortable.abort()
})

// abort the stream and end with an error
abortable.abort(new Error('example'))
```

## License

MIT

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