# Standard Input
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Standard input][standard-streams].
## Installation
```bash
npm install @stdlib/streams-node-stdin
```
## Usage
```javascript
var stdin = require( '@stdlib/streams-node-stdin' );
```
#### stdin
[Standard input][standard-streams] as a [Readable stream][readable-stream].
```javascript
var string2buffer = require( '@stdlib/buffer-from-string' );
var Buffer = require( '@stdlib/buffer-ctor' );
var data = [];
var len = 0;
stdin.on( 'readable', onReadable );
stdin.on( 'error', onError );
stdin.on( 'end', onEnd );
function onReadable() {
var chunk;
while ( true ) {
chunk = stdin.read();
if ( chunk === null ) {
break;
}
if ( typeof chunk === 'string' ) {
chunk = string2buffer( chunk );
}
data.push( chunk );
len += chunk.length;
}
}
function onError( error ) {
if ( error ) {
console.error( error.message );
}
}
function onEnd() {
data = Buffer.concat( data, len );
console.log( data.toString() );
// => '...'
}
```
## Examples
```javascript
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][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/streams-node-stdin.svg
[npm-url]: https://npmjs.org/package/@stdlib/streams-node-stdin
[test-image]: https://github.com/stdlib-js/streams-node-stdin/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/streams-node-stdin/actions/workflows/test.yml
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/streams-node-stdin/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/streams-node-stdin?branch=main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/streams-node-stdin/tree/deno
[umd-url]: https://github.com/stdlib-js/streams-node-stdin/tree/umd
[esm-url]: https://github.com/stdlib-js/streams-node-stdin/tree/esm
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/streams-node-stdin/main/LICENSE
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams
[readable-stream]: https://nodejs.org/api/stream.html#stream_class_stream_readable