documentation.federated.com.../node_modules/get-stdin
2023-05-30 11:55:11 -06:00
..
index.d.ts initial 2023-05-30 11:55:11 -06:00
index.js initial 2023-05-30 11:55:11 -06:00
license initial 2023-05-30 11:55:11 -06:00
package.json initial 2023-05-30 11:55:11 -06:00
readme.md initial 2023-05-30 11:55:11 -06:00

get-stdin

Get stdin as a string or buffer

Install

$ npm install get-stdin

Usage

// example.js
import getStdin from 'get-stdin';

console.log(await getStdin());
//=> 'unicorns'
$ echo unicorns | node example.js
unicorns

API

Both methods returns a promise that is resolved when the end event fires on the stdin stream, indicating that there is no more data to be read.

getStdin()

Get stdin as a string.

In a TTY context, a promise that resolves to an empty string is returned.

getStdin.buffer()

Get stdin as a Buffer.

In a TTY context, a promise that resolves to an empty Buffer is returned.


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.