Skip to content

Repository files navigation

pause

NPM VersionNPM DownloadsNode.js VersionBuild StatusTest Coverage

Pause a stream's data events

Installation

$ npm install pause

API

varpause=require('pause')

handle = pause(stream)

Pause the data events on a stream and return a handle to resume or end the stream.

handle.end()

Dispose of the handle. This does not end the stream, but it simply discards the event collection, making handle.resume() a no-op.

handle.resume()

Resume the stream by re-emitting all the data events in the same order, followed by an end event, if that was emitting during the pause.

License

MIT

About

Pause a stream's data events

Topics

Resources

Stars

27 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages