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.
31 lines
717 B
31 lines
717 B
/// <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;
|
|
|