www.aleph1.co.uk Git - yaffs-website/blob - node_modules/supports-color/readme.md

   1 # supports-color [![Build Status](https://travis-ci.org/chalk/supports-color.svg?branch=master)](https://travis-ci.org/chalk/supports-color)
   2
   3 > Detect whether a terminal supports color
   4
   5
   6 ## Install
   7
   8 ```
   9 $ npm install --save supports-color
  10 ```
  11
  12
  13 ## Usage
  14
  15 ```js
  16 var supportsColor = require('supports-color');
  17
  18 if (supportsColor) {
  19         console.log('Terminal supports color');
  20 }
  21 ```
  22
  23 It obeys the `--color` and `--no-color` CLI flags.
  24
  25 For situations where using `--color` is not possible, add an environment variable `FORCE_COLOR` with any value to force color. Trumps `--no-color`.
  26
  27
  28 ## Related
  29
  30 - [supports-color-cli](https://github.com/chalk/supports-color-cli) - CLI for this module
  31 - [chalk](https://github.com/chalk/chalk) - Terminal string styling done right
  32
  33
  34 ## License
  35
  36 MIT © [Sindre Sorhus](http://sindresorhus.com)