History

Florian Dold d1291f6755 node_modules		2016-11-03 01:33:53 +01:00
..
.npmignore	add node_modules to address #4364	2016-10-10 03:43:44 +02:00
.travis.yml	add node_modules to address #4364	2016-10-10 03:43:44 +02:00
index.js	add node_modules to address #4364	2016-10-10 03:43:44 +02:00
Makefile	add node_modules to address #4364	2016-10-10 03:43:44 +02:00
package.json	node_modules	2016-11-03 01:33:53 +01:00
README.md	add node_modules to address #4364	2016-10-10 03:43:44 +02:00

README.md

Stream to Array

Concatenate a readable stream's data into a single array.

API

var toArray = require('stream-to-array')
var stream = fs.createReadStream('some file.txt')

toArray([stream], [callback(err, arr)])

Returns all the data objects in an array. This is useful for streams in object mode if you want to just use an array.

streamTo.array(stream, function (err, arr) {
  assert.ok(Array.isArray(arr))
})

If stream is not defined, it is assumed that this is a stream.

var stream = new Stream.Readable()
stream.toArray = toArray
stream.toArray(function (err, arr) {

})

If callback is not defined, then it is assumed that it is being yielded within a generator.

function* () {
  var stream = new Stream.Readable()
  stream.toArray = toArray
  var arr = yield stream.toArray()
}

If you want to return a buffer, just use Buffer.concat(arr)

var stream = new Stream.Readable()
var arr = yield toArray(stream)
var buffer = Buffer.concat(arr)

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.