Standard Output

Standard output.

Installation

npm install @stdlib/streams-node-stdout

Usage

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

stdout

Standard output as a Writable stream.

// Write to the terminal...
stdout.write( 'beep', 'utf8' );
// e.g., => 'beep'

Notes

• Unlike other streams, stdout 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 stdout = require( '@stdlib/streams-node-stdout' );

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

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

// 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 );

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.