diff options
author | Minteck <freeziv.ytb@gmail.com> | 2021-03-07 18:29:17 +0100 |
---|---|---|
committer | Minteck <freeziv.ytb@gmail.com> | 2021-03-07 18:29:17 +0100 |
commit | 0f79e708bf07721b73ea41e5d341be08e8ea4dce (patch) | |
tree | f3c63cd6a9f4ef0b26f95eec6a031600232e80c8 /node_modules/is-interactive/index.d.ts | |
download | electrode-0f79e708bf07721b73ea41e5d341be08e8ea4dce.tar.gz electrode-0f79e708bf07721b73ea41e5d341be08e8ea4dce.tar.bz2 electrode-0f79e708bf07721b73ea41e5d341be08e8ea4dce.zip |
Initial commit
Diffstat (limited to 'node_modules/is-interactive/index.d.ts')
-rw-r--r-- | node_modules/is-interactive/index.d.ts | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/node_modules/is-interactive/index.d.ts b/node_modules/is-interactive/index.d.ts new file mode 100644 index 0000000..5984dc6 --- /dev/null +++ b/node_modules/is-interactive/index.d.ts @@ -0,0 +1,31 @@ +/// <reference types="node"/> + +declare namespace isInteractive { + interface Options { + /** + The stream to check. + + @default process.stdout + */ + readonly stream?: NodeJS.WritableStream; + } +} + +/** +Check if stdout or stderr is [interactive](https://unix.stackexchange.com/a/43389/7678). + +It checks that the stream is [TTY](https://jameshfisher.com/2017/12/09/what-is-a-tty/), not a dumb terminal, and not running in a CI. + +This can be useful to decide whether to present interactive UI or animations in the terminal. + +@example +``` +import isInteractive = require('is-interactive'); + +isInteractive(); +//=> true +``` +*/ +declare function isInteractive(options?: isInteractive.Options): boolean; + +export = isInteractive; |