diff options
Diffstat (limited to 'node_modules/get-stdin/readme.md')
-rw-r--r-- | node_modules/get-stdin/readme.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/node_modules/get-stdin/readme.md b/node_modules/get-stdin/readme.md new file mode 100644 index 0000000..cc9ec1a --- /dev/null +++ b/node_modules/get-stdin/readme.md @@ -0,0 +1,55 @@ +# get-stdin [![Build Status](https://travis-ci.org/sindresorhus/get-stdin.svg?branch=master)](https://travis-ci.org/sindresorhus/get-stdin) + +> Get [stdin](https://nodejs.org/api/process.html#process_process_stdin) as a string or buffer + + +## Install + +``` +$ npm install get-stdin +``` + + +## Usage + +```js +// example.js +const getStdin = require('get-stdin'); + +getStdin().then(str => { + console.log(str); + //=> '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 + +- [get-stream](https://github.com/sindresorhus/get-stream) - Get a stream as a string or buffer + + +## License + +MIT © [Sindre Sorhus](https://sindresorhus.com) |