noop-stream

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

Usage no npm install needed!

<script type="module">
  import noopStream from 'https://cdn.skypack.dev/noop-stream';
</script>

README

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