is-interactive

WebJar for is-interactive

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

is-interactive
Last Version

Last Version

1.0.0
Release Date

Release Date

Type

Type

jar
Description

Description

is-interactive
WebJar for is-interactive
Project URL

Project URL

https://www.webjars.org
Source Code Management

Source Code Management

https://github.com/sindresorhus/is-interactive

Download is-interactive

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/is-interactive/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>is-interactive</artifactId>
    <version>1.0.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/is-interactive/
implementation 'org.webjars.npm:is-interactive:1.0.0'
// https://jarcasting.com/artifacts/org.webjars.npm/is-interactive/
implementation ("org.webjars.npm:is-interactive:1.0.0")
'org.webjars.npm:is-interactive:jar:1.0.0'
<dependency org="org.webjars.npm" name="is-interactive" rev="1.0.0">
  <artifact name="is-interactive" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='is-interactive', version='1.0.0')
)
libraryDependencies += "org.webjars.npm" % "is-interactive" % "1.0.0"
[org.webjars.npm/is-interactive "1.0.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

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.

Versions

Version
1.0.0