aboutsummaryrefslogtreecommitdiff
path: root/node_modules/is-interactive/index.d.ts
blob: 5984dc60e4b69775f1acb49180de405b6d853822 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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;