supports-color
    Overview
    Documentation
    Tutorials
    Chat
    Insights
    Code
    Dependencies
    Contributors
    Jobs

supports-color

Detect whether a terminal supports color

7.0.0  •  Updated 10 months ago  •  by chalk  •  MIT License

Detect whether a terminal supports color

Install

$ npm install supports-color

Usage

const supportsColor = require('supports-color');

if (supportsColor.stdout) {
	console.log('Terminal stdout supports color');
}

if (supportsColor.stdout.has256) {
	console.log('Terminal stdout supports 256 colors');
}

if (supportsColor.stderr.has16m) {
	console.log('Terminal stderr supports 16 million colors (truecolor)');
}

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.

The stdout/stderr objects 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, use the environment variable FORCE_COLOR=1 (level 1), FORCE_COLOR=2 (level 2), or FORCE_COLOR=3 (level 3) 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

Maintainers


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Popularity

Maintenance

Development

Last ver 10 months ago
Created 6 years ago
Last commit 6 months ago
15 days between commits

Technology

Node version: 8.16.0
6.9K unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

30 contributors
Sindre Sorhus
Maintainer, 95 commits, 30 merges
Qix
Maintainer, 18 commits, 2 merges, 8 PRs
lukasreinfurt
8 commits
刘祺
3 commits, 3 PRs
Works at JuMei inc
Joshua Boy Nicolai Appelman
1 commits, 1 merges, 3 PRs
Works at Google
Aaron Abramov
2 commits, 2 PRs
Works at Facebook

Tags

color
colour
colors
terminal
console
cli
ansi
styles
tty
rgb
256
shell
xterm
command-line
support
supports
capability
detect
truecolor
16m
Openbase helps developers choose among and use millions of open-source packages, so they can build amazing products faster.
FacebookTwitterLinkedIn
© 2020 Devstore, Inc.