destroy
destroy a stream if possible
Last updated 4 years ago by dougwilson .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install destroy 
SYNC missed versions from official npm registry.

Destroy

NPM version Build status Test coverage License Downloads Gittip

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:

  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 not an instance of Stream, then nothing happens.
  3. 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)

Current Tags

  • 1.0.4                                ...           latest (4 years ago)

2 Versions

  • 1.0.4                                ...           4 years ago
  • 1.0.3                                ...           6 years ago
Maintainers (1)
Downloads
Today 13,241
This Week 147,332
This Month 79,096
Last Day 33,532
Last Week 153,469
Last Month 774,231
Dependencies (0)
None
Dev Dependencies (2)
Dependents (283)

Copyright 2014 - 2016 © taobao.org |