time-to-botec/squiggle/node_modules/@stdlib/streams/node/stderr/README.md

Standard Error

Standard error.

Usage

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

stderr

Standard error as a Writable stream.

// Write to the terminal...
stderr.write( 'Oh no!', 'utf8' );
// e.g., => 'Oh no!'

Notes

• Unlike other streams, stderr can never be closed and, thus, never emits a 'finish' event.
• Although rare, writes can block when output is redirected to a file.

Examples

var proc = require( 'process' );
var stdin = require( '@stdlib/streams/node/stdin' );
var stderr = require( '@stdlib/streams/node/stderr' );

// Set the encoding:
stdin.setEncoding( 'utf8' );

// Create an echo stream:
stdin.pipe( stderr );

// Push data to `stdin`:
stdin.push( 'beep' );
stdin.push( ' ' );
stdin.push( 'boop' );
stdin.push( '\n' );

// End the stream:
stdin.push( null );

// Ensure the process closes:
setTimeout( proc.exit, 1000 );