destroy (1.2.0)
Published 2026-02-24 13:55:25 +00:00 by atheaadmin
Installation
registry=npm install destroy@1.2.0"destroy": "1.2.0"About this package
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)
Dependencies
Development Dependencies
| ID | Version |
|---|---|
| eslint | 7.32.0 |
| eslint-config-standard | 14.1.1 |
| eslint-plugin-import | 2.25.4 |
| eslint-plugin-node | 11.1.0 |
| eslint-plugin-promise | 5.2.0 |
| eslint-plugin-standard | 4.1.0 |
| mocha | 9.2.2 |
| nyc | 15.1.0 |
Keywords
stream
streams
destroy
cleanup
leak
fd