Skip to content

alanshaw/cli-color-tty

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cli-color-tty Build Status Dependency Status Coverage Status

The cli-color module but TTY aware. It provides a cli-color compatible API that doesn't colorize your strings for non-TTY use.

Example

var clc = require('cli-color-tty')(true)
// clc is = require('cli-color')

console.log(clc.red('RED')) // -> '\x1b[31mRED\x1b[39m'

clc = require('cli-color-tty')(false)
// clc is a cli-color compatible API that doesn't colorize

console.log(clc.red('RED')) // -> 'RED'

Usage

var clc = require('cli-color-tty')(/* true/false/default: process.stdout.isTTY */)

After calling the factory function, use it as per the cli-color docs.

Pass true to the factory function to get back the cli-color module.
Pass false to get back a cli-color compatible object that doesn't colorize your strings.
Defaults to process.stdout.isTTY

About

cli-color that takes into account process.stdout.isTTY

Resources

License

Stars

Watchers

Forks

Packages

No packages published