read-all-stream

    3.1.0 • Public • Published

    read-all-stream Build Status

    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

    Install

    npm i read-all-stream

    DownloadsWeekly Downloads

    378,233

    Version

    3.1.0

    License

    MIT

    Last publish

    Collaborators

    • floatdrop