Skip to content
This repository has been archived by the owner on Jun 5, 2020. It is now read-only.
/ ansi-colorizer Public archive

Colorize/brighten text for terminals with ANSI escape sequences

License

Notifications You must be signed in to change notification settings

busterjs/ansi-colorizer

Repository files navigation

ansi-colorizer

Build status

Dim and bright pretty shell colors

ansi-colorizer is a small utility to add ANSI escape sequences to strings to output them with color. Configuring the colorizer produces an object that may or may not colorize or brighten text.

configure(options)

Returns a new colorizer instance. Configuration options are color and bright. Both are booleans, and both are false by default. If both settings are false (the default), the colorizer will not really do anything. When color is true, methods colorize strings. When bright is true, all color methods will result in the bright color variant.

var ansiColorizer = require("ansi-colorizer");

var colorizer = ansiColorizer.configure({ color: true, bright: false });
colorizer.red("Hey"); //=> "\x1b[31mHey\x1b[0m"

colorizer = ansiColorizer.configure({ color: true, bright: trie });
colorizer.red("Hey"); //=> "\x1b[1m\x1b[31mHey\x1b[0m"

colorizer = ansiColorizer.configure();
colorizer.red("Hey"); //=> "Hey"

bold(string)

Brightens the string.

red(string)

Colors string red.

yellow(string)

Colors string yellow.

green(string)

Colors string green.

purple(string)

Colors string purple.

cyan(string)

Colors string cyan.

grey(string)

Colors string grey.

About

Colorize/brighten text for terminals with ANSI escape sequences

Resources

License

Stars

Watchers

Forks

Packages

No packages published