ansi-colors-prioritized
v0.1.2
Published
Enables prioritized and nested coloring of texts
Downloads
10
Readme
ansi-colors-prioritized
Enables prioritized and nestable coloring of texts using ansi-colors.
Install
$ npm install ansi-colors-prioritized --save-dev
Usage
const prioritizedColor = require('ansi-color-prioritized');
const chaik = require('chalk');
const ansiColors = require('ansi-colors');
colorCandidate0 = ''; // null, empty or unsupported color name
colorCandidate1 = ansi.green;
colorCandidate2 = ansi.gray;
const color = prioritizedColor(colorCandidate0, colorCandidate1, colorCandidate2);
color('This package enables ', ansi.red('prioritized'), ' and ', ansi.magenta('nested'), ' coloring.');
// color is colorCandidate1 (ansi.green) in this case.
API
prioritizedColor(...color) : function
This function accepts multiple arguments each of which is either a coloring function or a color name, and chooses first available color among the arguments.
This function returns a coloring function, which is created by ansi-colors-nestable inside of this package, and accepts multiple argument texts and colors each of them with the chosen color. Therefore this returned function supports nested coloring.
This function uses the package ansi-colors inside for supporting Node.js >= v0.10. So color names need to be supported by ansi-colors.
Parameters:
| Parameter | Type | Description | |:----------|:---------------:|:--------------------------------| | color | string|function | color name or coloring function |
Returns:
A coloring function which can colorize multiple argument texts.
Type: function
License
Copyright (C) 2017 Takayuki Sato
This program is free software under MIT License. See the file LICENSE in this distribution for more details.