관리-도구

편집 파일: index.d.ts

/**
Basic foreground colors.

/**
Basic background colors.

/**
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 namespace chalk {
	/**
	Levels:
	- `0` - All colors disabled.
	- `1` - Basic 16 colors support.
	- `2` - ANSI 256 colors support.
	- `3` - Truecolor 16 million colors support.
	*/
	type Level = 0 | 1 | 2 | 3;

interface Options {
		/**
		Specify the color support for Chalk.

By default, color support is automatically detected based on the environment.

Levels:
		- `0` - All colors disabled.
		- `1` - Basic 16 colors support.
		- `2` - ANSI 256 colors support.
		- `3` - Truecolor 16 million colors support.
		*/
		level?: Level;
	}

/**
	Return a new Chalk instance.
	*/
	type 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}%}
		`);
		```

@example
		```
		import chalk = require('chalk');

log(chalk.red.bgBlack`2 + 3 = {bold ${2 + 3}}`)
		```
		*/
		(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.

Levels:
		- `0` - All colors disabled.
		- `1` - Basic 16 colors support.
		- `2` - ANSI 256 colors support.
		- `3` - Truecolor 16 million colors support.
		*/
		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;

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: chalk.Level;
	Color: Color;
	ForegroundColor: ForegroundColor;
	BackgroundColor: BackgroundColor;
	Modifiers: Modifiers;
	stderr: chalk.Chalk & {supportsColor: chalk.ColorSupport | false};
};

export = chalk;