1
0
Fork 0
mirror of https://github.com/shimataro/ssh-key-action.git synced 2025-06-19 22:52:10 +10:00
ssh-key-action/node_modules/get-stdin
2019-09-18 20:39:54 +09:00
..
index.d.ts * first action! (#1) 2019-09-18 20:39:54 +09:00
index.js * first action! (#1) 2019-09-18 20:39:54 +09:00
license * first action! (#1) 2019-09-18 20:39:54 +09:00
package.json * first action! (#1) 2019-09-18 20:39:54 +09:00
readme.md * first action! (#1) 2019-09-18 20:39:54 +09:00

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