You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
33 lines
905 B
33 lines
905 B
/// <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;
|
|
|