https://github.com/floatdrop/read-all-stream

Read stream to buffer or string
https://github.com/floatdrop/read-all-stream

Last synced: 3 months ago
JSON representation

Read stream to buffer or string

• Host: GitHub
• URL: https://github.com/floatdrop/read-all-stream
• Owner: floatdrop
• License: mit
• Created: 2014-11-09T07:58:25.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-01-27T17:41:20.000Z (almost 9 years ago)
• Last Synced: 2024-10-25T03:13:41.639Z (3 months ago)
• Language: JavaScript
• Size: 21.5 KB
• Stars: 15
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# read-all-stream [![Build Status][travis-image]][travis-url]

> Read stream to buffer or string

## Install

```

$ npm install --save read-all-stream

```

## Usage

```js

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]([email protected])

[travis-url]: https://travis-ci.org/floatdrop/read-all-stream

[travis-image]: https://img.shields.io/travis/floatdrop/read-all-stream.svg