diff options
Diffstat (limited to 'node_modules/is-interactive/index.d.ts')
-rw-r--r-- | node_modules/is-interactive/index.d.ts | 25 |
1 files changed, 25 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..bf96f71 --- /dev/null +++ b/node_modules/is-interactive/index.d.ts @@ -0,0 +1,25 @@ +export 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 from 'is-interactive'; + +isInteractive(); +//=> true +``` +*/ +export default function isInteractive(options?: Options): boolean; |