Natively Pronounced Mandarin

    @stdlib/streams-node-stdin
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    Standard Input

    NPM version Build Status Coverage Status

    Standard input.

    Installation

    npm install @stdlib/streams-node-stdin

    Usage

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

    stdin

    Standard input as a Readable stream.

    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

    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/streams-node-stdin

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    159,738

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    34.1 kB

    Total Files

    8

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser