|
Last change
on this file since 571e0df was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago |
|
initial commit
|
-
Property mode
set to
100644
|
|
File size:
1.9 KB
|
| Rev | Line | |
|---|
| [6a3a178] | 1 | # is-interactive [](https://travis-ci.com/sindresorhus/is-interactive)
|
|---|
| 2 |
|
|---|
| 3 | > Check if stdout or stderr is [interactive](https://unix.stackexchange.com/a/43389/7678)
|
|---|
| 4 |
|
|---|
| 5 | 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.
|
|---|
| 6 |
|
|---|
| 7 | This can be useful to decide whether to present interactive UI or animations in the terminal.
|
|---|
| 8 |
|
|---|
| 9 |
|
|---|
| 10 | ## Install
|
|---|
| 11 |
|
|---|
| 12 | ```
|
|---|
| 13 | $ npm install is-interactive
|
|---|
| 14 | ```
|
|---|
| 15 |
|
|---|
| 16 |
|
|---|
| 17 | ## Usage
|
|---|
| 18 |
|
|---|
| 19 | ```js
|
|---|
| 20 | const isInteractive = require('is-interactive');
|
|---|
| 21 |
|
|---|
| 22 | isInteractive();
|
|---|
| 23 | //=> true
|
|---|
| 24 | ```
|
|---|
| 25 |
|
|---|
| 26 |
|
|---|
| 27 | ## API
|
|---|
| 28 |
|
|---|
| 29 | ### isInteractive(options?)
|
|---|
| 30 |
|
|---|
| 31 | #### options
|
|---|
| 32 |
|
|---|
| 33 | Type: `object`
|
|---|
| 34 |
|
|---|
| 35 | ##### stream
|
|---|
| 36 |
|
|---|
| 37 | Type: [`stream.Writable`](https://nodejs.org/api/stream.html#stream_class_stream_writable)<br>
|
|---|
| 38 | Default: [`process.stdout`](https://nodejs.org/api/process.html#process_process_stdout)
|
|---|
| 39 |
|
|---|
| 40 | The stream to check.
|
|---|
| 41 |
|
|---|
| 42 |
|
|---|
| 43 | ## FAQ
|
|---|
| 44 |
|
|---|
| 45 | #### Why are you not using [`ci-info`](https://github.com/watson/ci-info) for the CI check?
|
|---|
| 46 |
|
|---|
| 47 | 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.
|
|---|
| 48 |
|
|---|
| 49 | #### Why does this even exist? It's just a few lines.
|
|---|
| 50 |
|
|---|
| 51 | 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](https://blog.sindresorhus.com/small-focused-modules-9238d977a92a).
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
