Narcissistic, Perfectly Modest

    noop-stream
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0 • Public • Published

    noop-stream

    Create a readable Node.js stream that produces no data (or optionally blank data) or a writable stream that discards data

    This can be useful for testing, fixtures, draining a stream, etc. (Example)

    It's like fs.createReadStream('/dev/null') but cross-platform.

    Install

    npm install noop-stream

    Usage

    import stream from 'stream';
    import {readableNoopStream} from 'noop-stream';
    
    stream.pipeline(readableNoopStream({size: 10}), process.stdout);
    import stream from 'stream';
    import {writableNoopStream} from 'noop-stream';
    
    stream.pipeline(process.stdin, writableNoopStream());

    API

    readableNoopStream(options?)

    Create a readable Node.js stream that produces no data (or optionally blank data).

    Options are passed to the stream.Readable constructor, except for the read option.

    You can also specify a size option, which is the size in bytes to produce. By default, it's 0. Set it to Infinity to make it produce data until you manually destroy the stream.

    writableNoopStream(options?)

    Create a writable Node.js stream that discards received data.

    Options are passed to the stream.Writable constructor, except for the write option.

    Related

    Install

    npm i noop-stream

    DownloadsWeekly Downloads

    2,968

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    5.77 kB

    Total Files

    5

    Last publish

    Collaborators

    • sindresorhus