tree: d99a2dde3421478819fd9294e5e3e07e7eb81a40 [path history] [tgz]
  1. index.d.ts
  2. index.js
  3. license
  4. package.json
  5. readme.md
setup-maven/node_modules/get-stdin/readme.md

get-stdin Build Status

Get stdin as a string or buffer

Install

$ npm install get-stdin

Usage

// example.js
const getStdin = require('get-stdin');

(async () => {
	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.

Related

License

MIT © Sindre Sorhus