diff options
Diffstat (limited to 'node_modules/stream-to-array/README.md')
-rw-r--r-- | node_modules/stream-to-array/README.md | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/node_modules/stream-to-array/README.md b/node_modules/stream-to-array/README.md new file mode 100644 index 000000000..56adf2dc5 --- /dev/null +++ b/node_modules/stream-to-array/README.md @@ -0,0 +1,77 @@ +# Stream to Array [![Build Status](https://travis-ci.org/stream-utils/stream-to-array.png)](https://travis-ci.org/stream-utils/stream-to-array) + +Concatenate a readable stream's data into a single array. + +You may also be interested in: + +- [raw-body](https://github.com/stream-utils/raw-body) for strings + +## API + +```js +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. + +```js +streamTo.array(stream, function (err, arr) { + assert.ok(Array.isArray(arr)) +}) +``` + +If `stream` is not defined, it is assumed that `this` is a stream. + +```js +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. + +```js +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)` + +```js +var stream = new Stream.Readable() +var arr = yield toArray(stream) +var buffer = Buffer.concat(arr) +``` + +## License + +The MIT License (MIT) + +Copyright (c) 2013 Jonathan Ong me@jongleberry.com + +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. |