mirror of
https://github.com/JamesIves/github-pages-deploy-action.git
synced 2023-12-15 20:03:39 +08:00
56 lines
1.0 KiB
Markdown
56 lines
1.0 KiB
Markdown
# 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');
|
|
|
|
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)
|