Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

p-stream

MiguelCastillo836MIT1.0.3

Readable stream to Promise

streams, promise, stream to promise

readme

p-stream

Readable stream to Promise

Create Promises that resolve when a readable stream is finished streaming data. Or rejected when the stream reports an error.

Promise must be polyfilled.

Examples

var fs = require("fs");
var pstream = require("p-stream");

function readFile(filePath) {
  return fs
    .createReadStream(filePath)
    .setEncoding("utf8");
}

pstream(readFile("somefile.log")).then(function(text) {
  console.log("File read", text);
});

p-stream can handle strings and buffers.

TIP: Make sure to set the encoding on the stream to properly handle utf8 strings. Please refer to setEncoding for more details.