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:

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 an instance of a zlib stream, then call stream.destroy() and close the underlying zlib handle if open, otherwise call stream.close(). This is for consistency across Node.js versions and a Node.js bug that will leak a native zlib handle.
3. If the stream is not an instance of Stream, then nothing happens.
4. 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)

1.2.0 / 2022-03-20

• Add suppress argument

1.1.1 / 2022-02-28

• Work around Zlib close bug in Node.js < 4.5.5

1.1.0 / 2022-01-25

• Add Zlib steam support and Node.js leak work around

1.0.4 / 2016-01-15

• perf: enable strict mode

1.0.3 / 2014-08-14

• Rename from dethroy to destroy

1.0.2 / 2014-08-14

• Work around fd leak in Node.js 0.10 for fs.ReadStream

1.0.1 / 2014-06-10

• Don't call .close on object without .destroy

1.0.0 / 2013-12-30

• Initial release