diff options
Diffstat (limited to 'node_modules/get-stdin/readme.md')
| -rw-r--r-- | node_modules/get-stdin/readme.md | 56 |
1 files changed, 0 insertions, 56 deletions
diff --git a/node_modules/get-stdin/readme.md b/node_modules/get-stdin/readme.md deleted file mode 100644 index ede347a0..00000000 --- a/node_modules/get-stdin/readme.md +++ /dev/null @@ -1,56 +0,0 @@ -# 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 -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. - -## Related - -- [get-stream](https://github.com/sindresorhus/get-stream) - Get a stream as a string or buffer - ---- - -<div align="center"> - <b> - <a href="https://tidelift.com/subscription/pkg/npm-get-stdin?utm_source=npm-get-stdin&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a> - </b> - <br> - <sub> - Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies. - </sub> -</div> |