123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411 |
- declare const enum LevelEnum {
- /**
- All colors disabled.
- */
- None = 0,
- /**
- Basic 16 colors support.
- */
- Basic = 1,
- /**
- ANSI 256 colors support.
- */
- Ansi256 = 2,
- /**
- Truecolor 16 million colors support.
- */
- TrueColor = 3
- }
- /**
- Basic foreground colors.
- [More colors here.](https://github.com/chalk/chalk/blob/master/readme.md#256-and-truecolor-color-support)
- */
- declare type ForegroundColor =
- | 'black'
- | 'red'
- | 'green'
- | 'yellow'
- | 'blue'
- | 'magenta'
- | 'cyan'
- | 'white'
- | 'gray'
- | 'grey'
- | 'blackBright'
- | 'redBright'
- | 'greenBright'
- | 'yellowBright'
- | 'blueBright'
- | 'magentaBright'
- | 'cyanBright'
- | 'whiteBright';
- /**
- Basic background colors.
- [More colors here.](https://github.com/chalk/chalk/blob/master/readme.md#256-and-truecolor-color-support)
- */
- declare type BackgroundColor =
- | 'bgBlack'
- | 'bgRed'
- | 'bgGreen'
- | 'bgYellow'
- | 'bgBlue'
- | 'bgMagenta'
- | 'bgCyan'
- | 'bgWhite'
- | 'bgGray'
- | 'bgGrey'
- | 'bgBlackBright'
- | 'bgRedBright'
- | 'bgGreenBright'
- | 'bgYellowBright'
- | 'bgBlueBright'
- | 'bgMagentaBright'
- | 'bgCyanBright'
- | 'bgWhiteBright';
- /**
- Basic colors.
- [More colors here.](https://github.com/chalk/chalk/blob/master/readme.md#256-and-truecolor-color-support)
- */
- declare type Color = ForegroundColor | BackgroundColor;
- declare type Modifiers =
- | 'reset'
- | 'bold'
- | 'dim'
- | 'italic'
- | 'underline'
- | 'inverse'
- | 'hidden'
- | 'strikethrough'
- | 'visible';
- declare namespace chalk {
- type Level = LevelEnum;
- interface Options {
- /**
- Specify the color support for Chalk.
- By default, color support is automatically detected based on the environment.
- */
- level?: Level;
- }
- interface Instance {
- /**
- Return a new Chalk instance.
- */
- new (options?: Options): Chalk;
- }
- /**
- Detect whether the terminal supports color.
- */
- interface ColorSupport {
- /**
- The color level used by Chalk.
- */
- level: Level;
- /**
- Return whether Chalk supports basic 16 colors.
- */
- hasBasic: boolean;
- /**
- Return whether Chalk supports ANSI 256 colors.
- */
- has256: boolean;
- /**
- Return whether Chalk supports Truecolor 16 million colors.
- */
- has16m: boolean;
- }
- interface ChalkFunction {
- /**
- Use a template string.
- @remarks Template literals are unsupported for nested calls (see [issue #341](https://github.com/chalk/chalk/issues/341))
- @example
- ```
- import chalk = require('chalk');
- log(chalk`
- CPU: {red ${cpu.totalPercent}%}
- RAM: {green ${ram.used / ram.total * 100}%}
- DISK: {rgb(255,131,0) ${disk.used / disk.total * 100}%}
- `);
- ```
- */
- (text: TemplateStringsArray, ...placeholders: unknown[]): string;
- (...text: unknown[]): string;
- }
- interface Chalk extends ChalkFunction {
- /**
- Return a new Chalk instance.
- */
- Instance: Instance;
- /**
- The color support for Chalk.
- By default, color support is automatically detected based on the environment.
- */
- level: Level;
- /**
- Use HEX value to set text color.
- @param color - Hexadecimal value representing the desired color.
- @example
- ```
- import chalk = require('chalk');
- chalk.hex('#DEADED');
- ```
- */
- hex(color: string): Chalk;
- /**
- Use keyword color value to set text color.
- @param color - Keyword value representing the desired color.
- @example
- ```
- import chalk = require('chalk');
- chalk.keyword('orange');
- ```
- */
- keyword(color: string): Chalk;
- /**
- Use RGB values to set text color.
- */
- rgb(red: number, green: number, blue: number): Chalk;
- /**
- Use HSL values to set text color.
- */
- hsl(hue: number, saturation: number, lightness: number): Chalk;
- /**
- Use HSV values to set text color.
- */
- hsv(hue: number, saturation: number, value: number): Chalk;
- /**
- Use HWB values to set text color.
- */
- hwb(hue: number, whiteness: number, blackness: number): Chalk;
- /**
- Use a [Select/Set Graphic Rendition](https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters) (SGR) [color code number](https://en.wikipedia.org/wiki/ANSI_escape_code#3/4_bit) to set text color.
- 30 <= code && code < 38 || 90 <= code && code < 98
- For example, 31 for red, 91 for redBright.
- */
- ansi(code: number): Chalk;
- /**
- Use a [8-bit unsigned number](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) to set text color.
- */
- ansi256(index: number): Chalk;
- /**
- Use HEX value to set background color.
- @param color - Hexadecimal value representing the desired color.
- @example
- ```
- import chalk = require('chalk');
- chalk.bgHex('#DEADED');
- ```
- */
- bgHex(color: string): Chalk;
- /**
- Use keyword color value to set background color.
- @param color - Keyword value representing the desired color.
- @example
- ```
- import chalk = require('chalk');
- chalk.bgKeyword('orange');
- ```
- */
- bgKeyword(color: string): Chalk;
- /**
- Use RGB values to set background color.
- */
- bgRgb(red: number, green: number, blue: number): Chalk;
- /**
- Use HSL values to set background color.
- */
- bgHsl(hue: number, saturation: number, lightness: number): Chalk;
- /**
- Use HSV values to set background color.
- */
- bgHsv(hue: number, saturation: number, value: number): Chalk;
- /**
- Use HWB values to set background color.
- */
- bgHwb(hue: number, whiteness: number, blackness: number): Chalk;
- /**
- Use a [Select/Set Graphic Rendition](https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters) (SGR) [color code number](https://en.wikipedia.org/wiki/ANSI_escape_code#3/4_bit) to set background color.
- 30 <= code && code < 38 || 90 <= code && code < 98
- For example, 31 for red, 91 for redBright.
- Use the foreground code, not the background code (for example, not 41, nor 101).
- */
- bgAnsi(code: number): Chalk;
- /**
- Use a [8-bit unsigned number](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit) to set background color.
- */
- bgAnsi256(index: number): Chalk;
- /**
- Modifier: Resets the current color chain.
- */
- readonly reset: Chalk;
- /**
- Modifier: Make text bold.
- */
- readonly bold: Chalk;
- /**
- Modifier: Emitting only a small amount of light.
- */
- readonly dim: Chalk;
- /**
- Modifier: Make text italic. (Not widely supported)
- */
- readonly italic: Chalk;
- /**
- Modifier: Make text underline. (Not widely supported)
- */
- readonly underline: Chalk;
- /**
- Modifier: Inverse background and foreground colors.
- */
- readonly inverse: Chalk;
- /**
- Modifier: Prints the text, but makes it invisible.
- */
- readonly hidden: Chalk;
- /**
- Modifier: Puts a horizontal line through the center of the text. (Not widely supported)
- */
- readonly strikethrough: Chalk;
- /**
- Modifier: Prints the text only when Chalk has a color support level > 0.
- Can be useful for things that are purely cosmetic.
- */
- readonly visible: Chalk;
- readonly black: Chalk;
- readonly red: Chalk;
- readonly green: Chalk;
- readonly yellow: Chalk;
- readonly blue: Chalk;
- readonly magenta: Chalk;
- readonly cyan: Chalk;
- readonly white: Chalk;
- /*
- Alias for `blackBright`.
- */
- readonly gray: Chalk;
- /*
- Alias for `blackBright`.
- */
- readonly grey: Chalk;
- readonly blackBright: Chalk;
- readonly redBright: Chalk;
- readonly greenBright: Chalk;
- readonly yellowBright: Chalk;
- readonly blueBright: Chalk;
- readonly magentaBright: Chalk;
- readonly cyanBright: Chalk;
- readonly whiteBright: Chalk;
- readonly bgBlack: Chalk;
- readonly bgRed: Chalk;
- readonly bgGreen: Chalk;
- readonly bgYellow: Chalk;
- readonly bgBlue: Chalk;
- readonly bgMagenta: Chalk;
- readonly bgCyan: Chalk;
- readonly bgWhite: Chalk;
- /*
- Alias for `bgBlackBright`.
- */
- readonly bgGray: Chalk;
- /*
- Alias for `bgBlackBright`.
- */
- readonly bgGrey: Chalk;
- readonly bgBlackBright: Chalk;
- readonly bgRedBright: Chalk;
- readonly bgGreenBright: Chalk;
- readonly bgYellowBright: Chalk;
- readonly bgBlueBright: Chalk;
- readonly bgMagentaBright: Chalk;
- readonly bgCyanBright: Chalk;
- readonly bgWhiteBright: Chalk;
- }
- }
- /**
- Main Chalk object that allows to chain styles together.
- Call the last one as a method with a string argument.
- Order doesn't matter, and later styles take precedent in case of a conflict.
- This simply means that `chalk.red.yellow.green` is equivalent to `chalk.green`.
- */
- declare const chalk: chalk.Chalk & chalk.ChalkFunction & {
- supportsColor: chalk.ColorSupport | false;
- Level: typeof LevelEnum;
- Color: Color;
- ForegroundColor: ForegroundColor;
- BackgroundColor: BackgroundColor;
- Modifiers: Modifiers;
- stderr: chalk.Chalk & {supportsColor: chalk.ColorSupport | false};
- };
- export = chalk;
|