Naughty Programmer's Madness

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

    0.0.7 • Public • Published

    stdin

    NPM version Build Status Coverage Status

    Read data from stdin.

    Installation

    npm install @stdlib/process-read-stdin

    Usage

    var stdin = require( '@stdlib/process-read-stdin' );

    stdin( [encoding,] clbk )

    Reads data from stdin.

    function onRead( error, data ) {
        if ( error ) {
            return console.error( 'Error: %s', error.message );
        }
        console.log( data.toString() );
        // => '...'
    }
    
    stdin( onRead );

    By default, returned data is a Buffer. To return a string of a specified encoding, provide an encoding parameter.

    function onRead( error, data ) {
        if ( error ) {
            return console.error( 'Error: %s', error.message );
        }
        console.log( data );
        // => '...'
    }
    
    stdin( 'utf8', onRead );

    When a file's calling Node.js process is running in a TTY context (i.e., no stdin), data will either be an empty Buffer (no encoding provided) or an empty string (encoding provided).

    var stream = require( '@stdlib/streams-node-stdin' );
    
    function onRead( error, data ) {
        if ( error ) {
            return console.error( 'Error: %s', error.message );
        }
        console.log( data );
        // => ''
    }
    
    stream.isTTY = true;
    
    stdin( 'utf8', onRead );

    Examples

    var string2buffer = require( '@stdlib/buffer-from-string' );
    var stream = require( '@stdlib/streams-node-stdin' );
    var stdin = require( '@stdlib/process-read-stdin' );
    
    function onRead( error, data ) {
        if ( error ) {
            console.error( 'Error: %s', error.message );
        } else {
            console.log( data.toString() );
            // => 'beep boop'
        }
    }
    
    // Fake not being in a terminal context:
    stream.isTTY = false;
    
    // Provide a callback to consume all data from `stdin`:
    stdin( onRead );
    
    // Push some data to `stdin`:
    stream.push( string2buffer( 'beep' ) );
    stream.push( string2buffer( ' ' ) );
    stream.push( string2buffer( 'boop' ) );
    
    // End the stream:
    stream.push( null );

    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/process-read-stdin

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    177,722

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    42.7 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser