flow-to-geckoboard/lib/objectMode.js

Creates a writable stream for pushing data to Geckoboard.

'use strict';

// MODULES //

var copy = require( 'utils-copy' ),
	Stream = require( './stream.js' );


// OBJECT MODE //

/**
* FUNCTION: objectMode( options )
*	Returns a stream with `objectMode` set to `true`.
*
* @param {Object} options - Writable stream options
* @param {String} options.key - API key
* @param {String} options.id - widget id
* @param {Boolean} [options.objectMode=false] - specifies whether stream should operate in object mode
* @param {Boolean} [options.decodeStrings=true] - specifies whether written strings should be decoded into Buffer objects
* @param {Number} [options.highWaterMark=16] - specifies the Buffer level for when `write()` starts returning `false`
* @returns {Stream} Writable stream
*/
function objectMode( options ) {
	var opts;
	if ( !arguments.length ) {
		throw new Error( 'unsufficient input arguments. Must provide stream options.' );
	}
	opts = copy( options );
	opts.objectMode = true;
	return new Stream( opts );
} // end FUNCTION objectMode()


// EXPORTS //

module.exports = objectMode;