History

zhouganqing 24739b1998 Import Upstream version 3.2.0+~cs4.2.0		2023-02-17 09:41:43 +08:00
..
.github	Import Upstream version 3.2.0+~cs4.2.0	2023-02-17 09:41:43 +08:00
.editorconfig	Import Upstream version 3.2.0+~cs4.2.0	2023-02-17 09:41:43 +08:00
.gitattributes	Import Upstream version 3.2.0+~cs4.2.0	2023-02-17 09:41:43 +08:00
.gitignore	Import Upstream version 3.2.0+~cs4.2.0	2023-02-17 09:41:43 +08:00
.npmrc	Import Upstream version 3.2.0+~cs4.2.0	2023-02-17 09:41:43 +08:00
.travis.yml	Import Upstream version 3.2.0+~cs4.2.0	2023-02-17 09:41:43 +08:00
index.d.ts	Import Upstream version 3.2.0+~cs4.2.0	2023-02-17 09:41:43 +08:00
index.js	Import Upstream version 3.2.0+~cs4.2.0	2023-02-17 09:41:43 +08:00
index.test-d.ts	Import Upstream version 3.2.0+~cs4.2.0	2023-02-17 09:41:43 +08:00
license	Import Upstream version 3.2.0+~cs4.2.0	2023-02-17 09:41:43 +08:00
package.json	Import Upstream version 3.2.0+~cs4.2.0	2023-02-17 09:41:43 +08:00
readme.md	Import Upstream version 3.2.0+~cs4.2.0	2023-02-17 09:41:43 +08:00
test.js	Import Upstream version 3.2.0+~cs4.2.0	2023-02-17 09:41:43 +08:00

readme.md

is-interactive

Check if stdout or stderr is interactive

It checks that the stream is 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.

Install

$ npm install is-interactive

Usage

const isInteractive = require('is-interactive');

isInteractive();
//=> true

API

isInteractive(options?)

options

Type: object

stream

Type: stream.Writable
Default: process.stdout

The stream to check.

FAQ

Why are you not using `ci-info` for the CI check?

It's silly to have to detect individual CIs. They should identify themselves with the CI environment variable, and most do just that. A manually maintained list of detections will easily get out of date. And if a package using ci-info doesn't update to the latest version all the time, they will not support certain CIs. It also creates unpredictability as you might assume a CI is not supported and then suddenly it gets supported and you didn't account for that. In addition, some of the manual detections are loose and might cause false-positives which could create hard-to-debug bugs.

Why does this even exist? It's just a few lines.

It's not about the number of lines, but rather discoverability and documentation. A lot of people wouldn't even know they need this. Feel free to copy-paste the code if you don't want the dependency. You might also want to read this blog post.