hasColors

fun hasColors(count: Number = definedExternally): Boolean(source)

Returns true if the writeStream supports at least as many colors as provided in count. Minimum support is 2 (black and white).

This has the same false positives and negatives as described in writeStream.getColorDepth().

process.stdout.hasColors();
// Returns true or false depending on if `stdout` supports at least 16 colors.
process.stdout.hasColors(256);
// Returns true or false depending on if `stdout` supports at least 256 colors.
process.stdout.hasColors({ TMUX: '1' });
// Returns true.
process.stdout.hasColors(2 ** 24, { TMUX: '1' });
// Returns false (the environment setting pretends to support 2 ** 8 colors).

Since

v11.13.0, v10.16.0

Parameters

env=process.env An object containing the environment variables to check. This enables simulating the usage of a specific terminal.


fun hasColors(count: Number, env: Any = definedExternally): Boolean(source)
fun hasColors(env: Any = definedExternally): Boolean(source)