Nuclear Pumpkin Mocha

    destroy
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/destroy package

    1.2.0 • Public • Published

    destroy

    NPM version Build Status Test coverage License Downloads

    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)

    Install

    npm i destroy

    DownloadsWeekly Downloads

    23,136,725

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    9.02 kB

    Total Files

    4

    Last publish

    Collaborators

    • dougwilson
    • jongleberry