pull-abortable

a pull-stream which may be aborted

Last updated 9 years ago by dominictarr .

MIT · Repository · Bugs · Original npm · Tarball · package.json

$ cnpm install pull-abortable

SYNC missed versions from official npm registry.

pull-abortable

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

example

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'))