Buckets:
215 MB
4,079 files
Updated 1 day ago
Ctrl+K
| Name | Size | Uploaded | Xet hash |
|---|---|---|---|
| LICENSE | 1.17 kB xet | 8e32688d | |
| README.md | 2.46 kB xet | 10c9cbdc | |
| index.js | 4.26 kB xet | d04b84c7 | |
| package.json | 1.13 kB xet | a9be48d2 |
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 [, suppress])
Destroy the given stream, and optionally suppress any future error events.
In most cases, this is identical to a simple stream.destroy() call. The rules
are as follows for a given stream:
- If the
streamis an instance ofReadStream, then callstream.destroy()and add a listener to theopenevent 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
streamis an instance of a zlib stream, then callstream.destroy()and close the underlying zlib handle if open, otherwise callstream.close(). This is for consistency across Node.js versions and a Node.js bug that will leak a native zlib handle. - If the
streamis not an instance ofStream, then nothing happens. - If the
streamhas 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)
- Total size
- 215 MB
- Files
- 4,079
- Last updated
- Aug 7
- Pre-warmed CDN
- US EU US EU