Palak Handa / startUpJalsa-Backend

Blame view

node_modules/destroy/README.md 2.13 KB
edit raw normal view history
f7563de62   Palak Handa   first commit 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
  # Destroy
  
  [![NPM version][npm-image]][npm-url]
  [![Build status][travis-image]][travis-url]
  [![Test coverage][coveralls-image]][coveralls-url]
  [![License][license-image]][license-url]
  [![Downloads][downloads-image]][downloads-url]
  [![Gittip][gittip-image]][gittip-url]
  
  Destroy a stream.
  
  This module is meant to ensure a stream gets destroyed, handling different APIs
  and Node.js bugs.
  
  ## API
  
  ```js
  var destroy = require('destroy')
  ```
  
  ### destroy(stream)
  
  Destroy the given stream. In most cases, this is identical to a simple
  `stream.destroy()` call. The rules are as follows for a given stream:
  
    1. If the `stream` is an instance of `ReadStream`, then call `stream.destroy()`
       and add a listener to the `open` event to call `stream.close()` if it is
       fired. This is for a Node.js bug that will leak a file descriptor if
       `.destroy()` is called before `open`.
    2. If the `stream` is not an instance of `Stream`, then nothing happens.
    3. If the `stream` has a `.destroy()` method, then call it.
  
  The function returns the `stream` passed in as the argument.
  
  ## Example
  
  ```js
  var destroy = require('destroy')
  
  var fs = require('fs')
  var stream = fs.createReadStream('package.json')
  
  // ... and later
  destroy(stream)
  ```
  
  [npm-image]: https://img.shields.io/npm/v/destroy.svg?style=flat-square
  [npm-url]: https://npmjs.org/package/destroy
  [github-tag]: http://img.shields.io/github/tag/stream-utils/destroy.svg?style=flat-square
  [github-url]: https://github.com/stream-utils/destroy/tags
  [travis-image]: https://img.shields.io/travis/stream-utils/destroy.svg?style=flat-square
  [travis-url]: https://travis-ci.org/stream-utils/destroy
  [coveralls-image]: https://img.shields.io/coveralls/stream-utils/destroy.svg?style=flat-square
  [coveralls-url]: https://coveralls.io/r/stream-utils/destroy?branch=master
  [license-image]: http://img.shields.io/npm/l/destroy.svg?style=flat-square
  [license-url]: LICENSE.md
  [downloads-image]: http://img.shields.io/npm/dm/destroy.svg?style=flat-square
  [downloads-url]: https://npmjs.org/package/destroy
  [gittip-image]: https://img.shields.io/gittip/jonathanong.svg?style=flat-square
  [gittip-url]: https://www.gittip.com/jonathanong/