Skip to content

empty

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

empty

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
 
 
bin
bin
 
 
docs
docs
 
 
etc
etc
 
 
examples
examples
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

Empty Stream

Create an "empty" readable stream.

Usage

var emptyStream = require( '@stdlib/streams/node/empty' );

emptyStream( [options] )

Returns an "empty" readable stream (i.e., a stream which never streams any values).

var inspectStream = require( '@stdlib/streams/node/inspect-sink' );

function log( chunk ) {
    // This function should never be called...
    console.log( chunk.toString() );
}

var stream = emptyStream();
var iStream = inspectStream( log );

stream.pipe( iStream );

The function accepts the following options:

  • objectMode: specifies whether a stream should operate in objectMode. Default: false.

To set stream options,

var opts = {
    'objectMode': true
};

var stream = emptyStream( opts );

emptyStream.factory( [options] )

Returns a function for creating "empty" readable streams.

var opts = {
    'objectMode': true
};

var createStream = emptyStream.factory( opts );

var stream1 = createStream();
var stream2 = createStream();
// ...

The method accepts the same options as emptyStream().

emptyStream.objectMode()

This method is a convenience function to create "empty" streams which always operate in objectMode.

var inspectStream = require( '@stdlib/streams/node/inspect-sink' );

function log( v ) {
    console.log( v );
}

var stream = emptyStream.objectMode();

var opts = {
    'objectMode': true
};
var iStream = inspectStream( opts, log );

stream.pipe( iStream );

Examples

var inspectStream = require( '@stdlib/streams/node/inspect-sink' );
var emptyStream = require( '@stdlib/streams/node/empty' );

function log( v ) {
    console.log( v.toString() );
}

var opts = {
    'objectMode': true
};
var stream = emptyStream( opts );

opts = {
    'objectMode': true
};
var iStream = inspectStream( opts, log );

stream.pipe( iStream );

CLI

Usage

Usage: empty-stream [options]

Options:

  -h,  --help               Print this message.
  -V,  --version            Print the package version.

Examples

$ empty-stream

See Also