Browse Source

readme tweaks

master
Sindre Sorhus 9 years ago
parent
commit
d153cdc43b
  1. 23
      readme.md

23
readme.md

@ -1,6 +1,6 @@
# get-stdin [![Build Status](https://travis-ci.org/sindresorhus/get-stdin.svg?branch=master)](https://travis-ci.org/sindresorhus/get-stdin)
> Get stdin as a string or buffer
> Get [stdin](https://nodejs.org/api/process.html#process_process_stdin) as a string or buffer
## Install
@ -14,10 +14,10 @@ $ npm install --save get-stdin
```js
// example.js
const stdin = require('get-stdin');
const getStdin = require('get-stdin');
stdin().then(x => {
console.log(x);
getStdin().then(str => {
console.log(str);
//=> 'unicorns'
});
```
@ -30,23 +30,26 @@ unicorns
## API
### stdin()
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.
Get `stdin` as a string.
### getStdin()
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.
Get `stdin` as a string.
In a TTY context, a promise that resolves to an empty string is returned.
### stdin.buffer()
### getStdin.buffer()
Get `stdin` as a buffer.
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.
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](http://sindresorhus.com)

Loading…
Cancel
Save