vnfmarket/src/main/webapp/vnfmarket/node_modules/pause/README.md

   1 # pause
   2
   3 [![NPM Version][npm-image]][npm-url]
   4 [![NPM Downloads][downloads-image]][downloads-url]
   5 [![Node.js Version][node-image]][node-url]
   6 [![Build Status][travis-image]][travis-url]
   7 [![Test Coverage][coveralls-image]][coveralls-url]
   8
   9 Pause a stream's data events
  10
  11 ## Installation
  12
  13 ```sh
  14 $ npm install pause
  15 ```
  16
  17 ## API
  18
  19 ```js
  20 var pause = require('pause')
  21 ```
  22
  23 ### handle = pause(stream)
  24
  25 Pause the data events on a stream and return a handle to resume or end the
  26 stream.
  27
  28 #### handle.end()
  29
  30 Dispose of the handle. This does not end the stream, but it simply discards
  31 the event collection, making `handle.resume()` a no-op.
  32
  33 #### handle.resume()
  34
  35 Resume the stream by re-emitting all the `data` events in the same order,
  36 followed by an `end` event, if that was emitting during the pause.
  37
  38 ## License
  39
  40 [MIT](LICENSE)
  41
  42 [npm-image]: https://img.shields.io/npm/v/pause.svg
  43 [npm-url]: https://npmjs.org/package/pause
  44 [node-image]: https://img.shields.io/node/v/pause.svg
  45 [node-url]: http://nodejs.org/download/
  46 [travis-image]: https://img.shields.io/travis/stream-utils/pause/master.svg
  47 [travis-url]: https://travis-ci.org/stream-utils/pause
  48 [coveralls-image]: https://img.shields.io/coveralls/stream-utils/pause.svg
  49 [coveralls-url]: https://coveralls.io/r/stream-utils/pause?branch=master
  50 [downloads-image]: https://img.shields.io/npm/dm/pause.svg
  51 [downloads-url]: https://npmjs.org/package/pause