summaryrefslogtreecommitdiff
path: root/node_modules/get-stdin/index.d.ts
diff options
context:
space:
mode:
authorPhilipp Tanlak <philipp.tanlak@gmail.com>2025-11-24 20:54:57 +0100
committerPhilipp Tanlak <philipp.tanlak@gmail.com>2025-11-24 20:57:48 +0100
commitb1e2c8fd5cb5dfa46bc440a12eafaf56cd844b1c (patch)
tree49d360fd6cbc6a2754efe93524ac47ff0fbe0f7d /node_modules/get-stdin/index.d.ts
Docs
Diffstat (limited to 'node_modules/get-stdin/index.d.ts')
-rw-r--r--node_modules/get-stdin/index.d.ts29
1 files changed, 29 insertions, 0 deletions
diff --git a/node_modules/get-stdin/index.d.ts b/node_modules/get-stdin/index.d.ts
new file mode 100644
index 0000000..c2a0605
--- /dev/null
+++ b/node_modules/get-stdin/index.d.ts
@@ -0,0 +1,29 @@
+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 from 'get-stdin';
+
+ 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 default getStdin;