Sha256: 460bfba5f7ef4a902163faa6b6d3d1fcce698ee4eb09f2e73ae1a0c3e17678d8
Contents?: true
Size: 1.04 KB
Versions: 23
Compression:
Stored size: 1.04 KB
Contents
# get-stdin [](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');
(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
- [get-stream](https://github.com/sindresorhus/get-stream) - Get a stream as a string or buffer
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)
Version data entries
23 entries across 23 versions & 1 rubygems