@stdlib/streams/node/empty/lib/object_mode.js

Streams.

/**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var EmptyStream = require( './main.js' );


// MAIN //

/**
* Returns an "objectMode" empty readable stream.
*
* @returns {EmptyStream} Stream instance
*
* @example
* var inspectStream = require( '@stdlib/streams/node/inspect-sink' );
*
* function log( v ) {
*    console.log( v );
* }
*
* var stream = objectMode();
*
* stream.pipe( inspectStream.objectMode( log ) );
*/
function objectMode() {
	var opts = {
		'objectMode': true
	};
	return new EmptyStream( opts );
}


// EXPORTS //

module.exports = objectMode;