then-read-stream

A promise based asynchronous stream reader.

Allows to read from a Readable Stream similar as you would read from a file.

Usage

The then-read-stream contains one class: StreamReader. The constructor of the StreamReader if provided with the stream.Readable you want to read from.

TypeScript:

import {StreamReader} from "then-read-stream";

const readThisStream = ... // Some stream of type stream.Readable
const streamReader = new StreamReader(readThisStream);

const buf = new Buffer(16);
  
return streamReader.read(buf, 0, 16).then((bytesRead) => {
    // If all went well, buf contains the promised 16 bytes of data read
  }).catch((err) => {
    if(err === StreamReader.EndOfStream) {
      // Rejected, bacause end of the stream has been reached
    }
  })

JavaScript:

var stream_reader = require("then-read-stream");

var readThisStream = ... // Some stream of type stream.Readable
var streamReader = new stream_reader.StreamReader(readThisStream);

return streamReader.read(buf, 0, 16).then( function(bytesRead) {
    // If all went well, buf contains the promised 16 bytes of data read
  }).catch( function(err) {
    if(err === stream_reader.StreamReader.EndOfStream) {
      // Rejected, bacause end of the stream has been reached
    }
  })