stream-utils / destroy

destroy a stream if possible

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)

destroy's Issues

do not destroy IncommingMessage

related: koajs/koa#612

any thoughts?

better docs

nodejs/node#1180

Emit 'close' on regular streams that don't have destroy()?

In Node.js 6, streams do not have a destroy() function. However, pipe, pump etc will destroy the pipeline if the stream emits a close event, so this will have the same effect in many circumstances.

What do you say that this module falls back to emit close as the last option in case there's no destroy() function available, but there is an emit() function?