www.aleph1.co.uk Git - yaffs-website/blob - node_modules/unpipe/README.md

   1 # unpipe
   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 Unpipe a stream from all destinations.
  10
  11 ## Installation
  12
  13 ```sh
  14 $ npm install unpipe
  15 ```
  16
  17 ## API
  18
  19 ```js
  20 var unpipe = require('unpipe')
  21 ```
  22
  23 ### unpipe(stream)
  24
  25 Unpipes all destinations from a given stream. With stream 2+, this is
  26 equivalent to `stream.unpipe()`. When used with streams 1 style streams
  27 (typically Node.js 0.8 and below), this module attempts to undo the
  28 actions done in `stream.pipe(dest)`.
  29
  30 ## License
  31
  32 [MIT](LICENSE)
  33
  34 [npm-image]: https://img.shields.io/npm/v/unpipe.svg
  35 [npm-url]: https://npmjs.org/package/unpipe
  36 [node-image]: https://img.shields.io/node/v/unpipe.svg
  37 [node-url]: http://nodejs.org/download/
  38 [travis-image]: https://img.shields.io/travis/stream-utils/unpipe.svg
  39 [travis-url]: https://travis-ci.org/stream-utils/unpipe
  40 [coveralls-image]: https://img.shields.io/coveralls/stream-utils/unpipe.svg
  41 [coveralls-url]: https://coveralls.io/r/stream-utils/unpipe?branch=master
  42 [downloads-image]: https://img.shields.io/npm/dm/unpipe.svg
  43 [downloads-url]: https://npmjs.org/package/unpipe