| | |
| | | # supports-color [](https://travis-ci.org/chalk/supports-color) |
| | | # supports-color |
| | | |
| | | > Detect whether a terminal supports color |
| | | |
| | | |
| | | ## Install |
| | | |
| | | ``` |
| | | $ npm install supports-color |
| | | ``` |
| | | |
| | | |
| | | ## Usage |
| | | |
| | |
| | | } |
| | | ``` |
| | | |
| | | |
| | | ## API |
| | | |
| | | Returns an `Object` with a `stdout` and `stderr` property for testing either streams. Each property is an `Object`, or `false` if color is not supported. |
| | |
| | | - `.level = 2` and `.has256 = true`: 256 color support |
| | | - `.level = 3` and `.has16m = true`: Truecolor support (16 million colors) |
| | | |
| | | ### `require('supports-color').supportsColor(stream, options?)` |
| | | |
| | | Additionally, `supports-color` exposes the `.supportsColor()` function that takes an arbitrary write stream (e.g. `process.stdout`) and an optional options object to (re-)evaluate color support for an arbitrary stream. |
| | | |
| | | For example, `require('supports-color').stdout` is the equivalent of `require('supports-color').supportsColor(process.stdout)`. |
| | | |
| | | The options object supports a single boolean property `sniffFlags`. By default it is `true`, which instructs `supportsColor()` to sniff `process.argv` for the multitude of `--color` flags (see _Info_ below). If `false`, then `process.argv` is not considered when determining color support. |
| | | |
| | | ## Info |
| | | |
| | |
| | | |
| | | Explicit 256/Truecolor mode can be enabled using the `--color=256` and `--color=16m` flags, respectively. |
| | | |
| | | |
| | | ## Related |
| | | |
| | | - [supports-color-cli](https://github.com/chalk/supports-color-cli) - CLI for this module |
| | | - [chalk](https://github.com/chalk/chalk) - Terminal string styling done right |
| | | |
| | | |
| | | ## Maintainers |
| | | |
| | | - [Sindre Sorhus](https://github.com/sindresorhus) |
| | | - [Josh Junon](https://github.com/qix-) |
| | | |
| | | |
| | | --- |
| | | |