diff options
Diffstat (limited to 'node_modules/supports-color/readme.md')
| -rw-r--r-- | node_modules/supports-color/readme.md | 42 |
1 files changed, 29 insertions, 13 deletions
diff --git a/node_modules/supports-color/readme.md b/node_modules/supports-color/readme.md index 32d4f46e9..f7bae4c54 100644 --- a/node_modules/supports-color/readme.md +++ b/node_modules/supports-color/readme.md @@ -1,11 +1,11 @@ -# supports-color [](https://travis-ci.org/sindresorhus/supports-color) +# supports-color [](https://travis-ci.org/chalk/supports-color) > Detect whether a terminal supports color ## Install -```sh +``` $ npm install --save supports-color ``` @@ -18,25 +18,41 @@ var supportsColor = require('supports-color'); if (supportsColor) { console.log('Terminal supports color'); } + +if (supportsColor.has256) { + console.log('Terminal supports 256 colors'); +} + +if (supportsColor.has16m) { + console.log('Terminal supports 16 million colors (truecolor)'); +} ``` -It obeys the `--color` and `--no-color` CLI flags. +## API -## CLI +Returns an `object`, or `false` if color is not supported. -```sh -$ npm install --global supports-color -``` +The returned object specifies a level of support for color through a `.level` property and a corresponding flag: -``` -$ supports-color --help +- `.level = 1` and `.hasBasic = true`: Basic color support (16 colors) +- `.level = 2` and `.has256 = true`: 256 color support +- `.level = 3` and `.has16m = true`: 16 million (truecolor) support - Usage - supports-color - Exits with code 0 if color is supported and 1 if not -``` +## Info + +It obeys the `--color` and `--no-color` CLI flags. + +For situations where using `--color` is not possible, add an environment variable `FORCE_COLOR` with any value to force color. Trumps `--no-color`. + +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 ## License |