1
0
Fork 0
mirror of https://github.com/actions/setup-python.git synced 2024-11-23 00:49:39 +00:00
setup-python/node_modules/get-stdin/index.d.ts
Danny McCormick 39c08a0eaa Initial pass
2019-06-26 21:12:00 -04:00

33 lines
905 B
TypeScript

/// <reference types="node"/>
declare const getStdin: {
/**
Get [`stdin`](https://nodejs.org/api/process.html#process_process_stdin) as a `string`.
@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, an empty `string` is returned.
@example
```
// example.ts
import getStdin = require('get-stdin');
(async () => {
console.log(await getStdin());
//=> 'unicorns'
})
// $ echo unicorns | ts-node example.ts
// unicorns
```
*/
(): Promise<string>;
/**
Get [`stdin`](https://nodejs.org/api/process.html#process_process_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, an empty `Buffer` is returned.
*/
buffer(): Promise<Buffer>;
};
export = getStdin;