ansi-colors-lazy
v1.0.0
Published
Lazyily loaded collection of ansi colors and styles.
Downloads
20
Maintainers
Keywords
Readme
ansi-colors-lazy
Lazyily loaded collection of ansi colors and styles.
Install
Install with npm:
$ npm install --save ansi-colors-lazy
Why was this module created?
This module was created to make it easy to allow color configuration through options. If your application will always use specific colors, we recommend requiring those modules directly. If your application requires using most of the colors, we recommend using ansi-colors for faster require times (the colors are inlined). When using only a few colors at a time or allowing users to choose from a few colors, this module will be more efficient due to lazy caching the underlying modules.
Usage
var colors = require('ansi-colors-lazy');
API
bgblack
Wrap a string with ansi codes to create a black background.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.bgblack('some string'));
bgblue
Wrap a string with ansi codes to create a blue background.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.bgblue('some string'));
bgcyan
Wrap a string with ansi codes to create a cyan background.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.bgcyan('some string'));
bggreen
Wrap a string with ansi codes to create a green background.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.bggreen('some string'));
bgmagenta
Wrap a string with ansi codes to create a magenta background.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.bgmagenta('some string'));
bgred
Wrap a string with ansi codes to create a red background.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.bgred('some string'));
bgwhite
Wrap a string with ansi codes to create a white background.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.bgwhite('some string'));
bgyellow
Wrap a string with ansi codes to create a yellow background.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.bgyellow('some string'));
black
Wrap a string with ansi codes to create black text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.black('some string'));
blue
Wrap a string with ansi codes to create blue text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.blue('some string'));
bold
Wrap a string with ansi codes to create bold text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.bold('some string'));
cyan
Wrap a string with ansi codes to create cyan text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.cyan('some string'));
dim
Wrap a string with ansi codes to create dim text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.dim('some string'));
gray
Wrap a string with ansi codes to create gray text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.gray('some string'));
green
Wrap a string with ansi codes to create green text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.green('some string'));
grey
Wrap a string with ansi codes to create grey text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.grey('some string'));
hidden
Wrap a string with ansi codes to create hidden text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.hidden('some string'));
inverse
Wrap a string with ansi codes to create inverse text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.inverse('some string'));
italic
Wrap a string with ansi codes to create italic text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.italic('some string'));
magenta
Wrap a string with ansi codes to create magenta text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.magenta('some string'));
red
Wrap a string with ansi codes to create red text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.red('some string'));
reset
Wrap a string with ansi codes to reset ansi colors currently on the string.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.reset('some string'));
strikethrough
Wrap a string with ansi codes to add a strikethrough to the text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.strikethrough('some string'));
underline
Wrap a string with ansi codes to underline the text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.underline('some string'));
white
Wrap a string with ansi codes to create white text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.white('some string'));
yellow
Wrap a string with ansi codes to create yellow text.
Params
str
{String}: String to wrap with ansi codes.returns
{String}: Wrapped string
Example
console.log(colors.yellow('some string'));
About
Related projects
- ansi-bgblack: The color bgblack, in ansi. | homepage
- ansi-bgblue: The color bgblue, in ansi. | homepage
- ansi-bgcyan: The color bgcyan, in ansi. | homepage
- ansi-bggreen: The color bggreen, in ansi. | homepage
- ansi-bgmagenta: The color bgmagenta, in ansi. | homepage
- ansi-bgred: The color bgred, in ansi. | homepage
- ansi-bgwhite: The color bgwhite, in ansi. | homepage
- ansi-bgyellow: The color bgyellow, in ansi. | homepage
- ansi-black: The color black, in ansi. | homepage
- ansi-blue: The color blue, in ansi. | homepage
- ansi-bold: The color bold, in ansi. | homepage
- ansi-cyan: The color cyan, in ansi. | homepage
- ansi-dim: The color dim, in ansi. | homepage
- ansi-gray: The color gray, in ansi. | homepage
- ansi-green: The color green, in ansi. | homepage
- ansi-grey: The color grey, in ansi. | homepage
- ansi-hidden: The color hidden, in ansi. | homepage
- ansi-inverse: The color inverse, in ansi. | homepage
- ansi-italic: The color italic, in ansi. | homepage
- ansi-magenta: The color magenta, in ansi. | homepage
- ansi-red: The color red, in ansi. | homepage
- ansi-reset: The color reset, in ansi. | homepage
- ansi-strikethrough: The color strikethrough, in ansi. | homepage
- ansi-underline: The color underline, in ansi. | homepage
- ansi-white: The color white, in ansi. | homepage
- ansi-yellow: The color yellow, in ansi. | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Contributors
Release history
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Author
Brian Woodward
License
Copyright © 2017, Brian Woodward. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on December 06, 2017.