Eric Foster 35b96bc934 initial commit | 6 vuotta sitten | |
---|---|---|
.. | ||
LICENSE | 6 vuotta sitten | |
README.md | 6 vuotta sitten | |
index.js | 6 vuotta sitten | |
package.json | 6 vuotta sitten |
Destroy a stream.
This module is meant to ensure a stream gets destroyed, handling different APIs and Node.js bugs.
var destroy = require('destroy')
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:
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
.stream
is not an instance of Stream
, then nothing happens.stream
has a .destroy()
method, then call it.The function returns the stream
passed in as the argument.
var destroy = require('destroy')
var fs = require('fs')
var stream = fs.createReadStream('package.json')
// ... and later
destroy(stream)