This repository has been archived on 2020-03-27. You can view files and clone it, but cannot push or open issues or pull requests.
Syllabus/themes/piratecare/node_modules/get-stdin
Marcell Mars c832f9bfdb hugo stuff... 2020-03-05 05:10:52 +01:00
..
index.d.ts hugo stuff... 2020-03-05 05:10:52 +01:00
index.js hugo stuff... 2020-03-05 05:10:52 +01:00
license hugo stuff... 2020-03-05 05:10:52 +01:00
package.json hugo stuff... 2020-03-05 05:10:52 +01:00
readme.md hugo stuff... 2020-03-05 05:10:52 +01:00

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.

License

MIT © Sindre Sorhus