diff options
Diffstat (limited to 'deps/npm/node_modules/update-notifier/node_modules/chalk/node_modules/supports-color/readme.md')
-rw-r--r-- | deps/npm/node_modules/update-notifier/node_modules/chalk/node_modules/supports-color/readme.md | 38 |
1 files changed, 34 insertions, 4 deletions
diff --git a/deps/npm/node_modules/update-notifier/node_modules/chalk/node_modules/supports-color/readme.md b/deps/npm/node_modules/update-notifier/node_modules/chalk/node_modules/supports-color/readme.md index b4761f1ecd..3bef57db0e 100644 --- a/deps/npm/node_modules/update-notifier/node_modules/chalk/node_modules/supports-color/readme.md +++ b/deps/npm/node_modules/update-notifier/node_modules/chalk/node_modules/supports-color/readme.md @@ -6,23 +6,47 @@ ## Install ``` -$ npm install --save supports-color +$ npm install supports-color ``` ## Usage ```js -var supportsColor = require('supports-color'); +const 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)'); +} ``` + +## API + +Returns an `Object`, or `false` if color is not supported. + +The returned object specifies a level of support for color through a `.level` property and a corresponding flag: + +- `.level = 1` and `.hasBasic = true`: Basic color support (16 colors) +- `.level = 2` and `.has256 = true`: 256 color support +- `.level = 3` and `.has16m = true`: Truecolor support (16 million colors) + + +## 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`. +Can be overridden by the user with the flags `--color` and `--no-color`. For situations where using `--color` is not possible, add the environment variable `FORCE_COLOR=1` to forcefully enable color or `FORCE_COLOR=0` to forcefully disable. The use of `FORCE_COLOR` overrides all other color support checks. + +Explicit 256/Truecolor mode can be enabled using the `--color=256` and `--color=16m` flags, respectively. ## Related @@ -31,6 +55,12 @@ For situations where using `--color` is not possible, add an environment variabl - [chalk](https://github.com/chalk/chalk) - Terminal string styling done right +## Maintainers + +- [Sindre Sorhus](https://github.com/sindresorhus) +- [Josh Junon](https://github.com/qix-) + + ## License -MIT © [Sindre Sorhus](http://sindresorhus.com) +MIT |