flow-from-array

from-array
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependencies][dependencies-image]][dependencies-url]

> Converts an array to a readable stream.

Installation

`` bash
$ npm install flow-from-array
`

For use in the browser, use browserify.

Usage

To use the module,

` javascript
var fromArray = require( 'flow-from-array' );
`

#### fromArray( arr[, options] )

Returns a readable stream where each emitted datum is an element from the input array.

To convert an array to a readable stream,

` javascript
var stream = fromArray( [1,2,3,4] );
`

To set the readable stream options,

` javascript
var opts = {
'objectMode': true,
'encoding': 'utf8',
'highWaterMark': 8
};

stream = fromArray( ['b','e','e','p'], opts );
`


#### fromArray.factory( [options] )

Returns a reusable stream factory. The factory method ensures streams are configured identically by using the same set of provided options.

` javascript
var opts = {
'objectMode': true,
'encoding': 'utf8',
'highWaterMark': 8
};

var factory = fromArray.factory( opts );

var streams = new Array( 10 ),
data;

// Create many streams configured identically but reading different datasets...
for ( var i = 0; i < streams.length; i++ ) {
data = new Array( 100 );
for ( var j = 0; j < data.length; j++ ) {
data[ j ] = Math.random();
}
streams[ i ] = factory( data );
}
`


#### fromArray.objectMode( arr[, options] )

This method is a convenience function to create readable streams which always operate in objectMode. The method will __always__ override the objectMode option in options.

` javascript
var fromArray = require( 'flow-from-array' ).objectMode;

fromArray( ['b','e','e','p'] )
.pipe( process.stdout );
`

Examples

` javascript
var append = require( 'flow-append' ).objectMode,
fromArray = require( 'flow-from-array' );

// Create some data...
var data = new Array( 1000 );
for ( var i = 0; i < data.length; i++ ) {
data[ i ] = Math.random();
}

// Create a readable stream:
var readableStream = fromArray( data );

// Pipe the data:
readableStream
.pipe( append( '\n' ) )
.pipe( process.stdout );
`

To run the example code from the top-level application directory,

` bash
$ node ./examples/index.js
`

Notes

This stream is a Streams2 version of event-stream and its readArray() method.

When in objectMode, an array cannot contain null or undefined values. An array containing either of these values will emit an error and close.

When not in objectMode, all array values are buffered. This means that anything which is not a buffer or a string is coerced into being a string. Values are stringified according to the following conventions:

* undefined: "undefined"
* null: "null"
* number: .toString()
* boolean: .toString()
* function: .toString()
* array: JSON.stringify( )
* object: JSON.stringify(