Notoriously Psychedelic Modules

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

    1.0.0 • Public • Published

    destroy-on-hwm

    NPM version Build status Test coverage Dependency Status License Downloads Gittip

    Destroys a writable stream if a write ever hits the high water mark. This is useful when piping a single stream to multiple clients - you don't want one client slowing down the rest of the clients. With how streams currently work, streams flow at the speed of the slowest destination stream.

    Usage

    var Stream = require('stream');
    var destroyOnHWM = require('destroy-on-hwm');
     
    var stream = new Stream.PassThrough();
     
    /**
     * With no callback, attempts to execute `stream.destroy()` on high water mark.
     * This stream does not have `.destroy()` though, so it's really a noop.
     */
     
    destroyOnHWM(stream);
     
    /**
     * Instead, we'll just use a custom callback.
     */
     
    destroyOnHWM(stream, function (stream) {
      assert(stream === this); // the stream is passed as both `this` and the first argument
      console.log('High water mark reached!');
    });

    Install

    npm i destroy-on-hwm

    DownloadsWeekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Last publish

    Collaborators

    • jongleberry