You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Laura Faust
dad579d5b1
|
3 years ago | |
---|---|---|
.. | ||
LICENSE | 3 years ago | |
README.md | 3 years ago | |
index.js | 3 years ago | |
package.json | 3 years ago |
README.md
Destroy
Destroy a stream.
This module is meant to ensure a stream gets destroyed, handling different APIs and Node.js bugs.
API
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:
- If the
stream
is an instance ofReadStream
, then callstream.destroy()
and add a listener to theopen
event to callstream.close()
if it is fired. This is for a Node.js bug that will leak a file descriptor if.destroy()
is called beforeopen
. - If the
stream
is not an instance ofStream
, then nothing happens. - If the
stream
has a.destroy()
method, then call it.
The function returns the stream
passed in as the argument.
Example
var destroy = require('destroy')
var fs = require('fs')
var stream = fs.createReadStream('package.json')
// ... and later
destroy(stream)