stream-source

A readable stream reader implementation on top of a Node readable stream. This library allows you to write code that takes a reader as input, and can work with either native readable streams or Node streams. For example:

var stream = require("stream-source");

function read(source) {
  return source.read().then(result => {
    if (result.done) return;
    process.stdout.write(result.value);
    return read(source);
  });
}

read(stream(process.stdin))
  .catch(error => console.error(error.stack));

The returned source is a sliceable source, which is to say that source.read accepts an optional length input allowing you to read the specified number of bytes from the underlying file.

API Reference

# stream(stream) <>

Returns a source for the specified node readable stream.

# source.read([length]) <>

Returns a Promise for the next chunk of data from the underlying stream. The yielded result is an object with the following properties:

• value - a Uint8Array (a Buffer), or undefined if the stream ended
• done - a boolean which is true if the stream ended

If an optional length is specified, the promise will be yielded with a value of length bytes, or the remaining bytes of the underlying stream if the underlying stream has more than zero but fewer than length bytes remaining. When no bytes remain in the stream, the yielded value will be undefined, and done will be true.

# source.cancel() <>

Returns a Promise which is resolved when the underlying stream has been destroyed.