read-all-stream

What is read-all-stream?

The 'read-all-stream' npm package is a utility that allows you to read all data from a stream until the end. It is particularly useful for handling streams in Node.js, such as reading data from files, HTTP responses, or any other stream-based data source.

What are read-all-stream's main functionalities?

Read all data from a stream

This feature allows you to read all data from a stream until the end. In this example, it reads the entire content of 'example.txt' and logs it to the console.

const readAllStream = require('read-all-stream');
const fs = require('fs');

const stream = fs.createReadStream('example.txt');

readAllStream(stream, 'utf8', (err, data) => {
  if (err) throw err;
  console.log(data);
});

Read all data from a stream with a promise

This feature allows you to read all data from a stream using a promise. It provides a more modern approach to handling asynchronous operations. In this example, it reads the entire content of 'example.txt' and logs it to the console.

const readAllStream = require('read-all-stream');
const fs = require('fs');

const stream = fs.createReadStream('example.txt');

readAllStream(stream, 'utf8').then(data => {
  console.log(data);
}).catch(err => {
  console.error(err);
});

Other packages similar to read-all-stream

concat-stream

The 'concat-stream' package is similar to 'read-all-stream' in that it also allows you to read all data from a stream. However, 'concat-stream' is more versatile as it can handle different types of data (strings, Buffers, arrays, etc.) and provides a simpler API for concatenating stream data.

get-stream

The 'get-stream' package is another alternative that provides similar functionality. It allows you to get the entire content of a stream as a string, buffer, or array. 'get-stream' also supports promises and async/await, making it a modern and flexible choice for handling streams.

stream-to-array

The 'stream-to-array' package converts a stream into an array of its data chunks. This can be useful if you need to process each chunk individually after reading the entire stream. It provides a different approach compared to 'read-all-stream' by focusing on chunk-based processing.

README

read-all-stream

Read stream to buffer or string

Install

$ npm install --save read-all-stream

Usage

var read = require('read-all-stream');
var stream = fs.createReadStream('index.js');

read(stream).then(function (data) {
	console.log(data.length);
});

read(stream, 'utf8', function (err, data) {
	console.log(data.length);
	//=> 42
});

API

read(stream, [options], [callback])

If callback is omitted, Promise will be returned.

stream

Required
Type: Stream

Event emitter, which data events will be consumed.

options

Type: object or string

If type of options is string, then it will be used as encoding. If type is Object, then next options are available:

options.encoding

Type: string, null
Default: 'utf8'

Encoding to be used on toString of the data. If null, the body is returned as a Buffer.

callback(err, data)

Will be called after stream is read.

err

Error object (if error event happens).

data

The data in stream.

License

MIT © Vsevolod Strukchinsky