Export TypeScript types for colors and modifiers (#357)
Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
This commit is contained in:
parent
1f77953f1a
commit
6b4d20683f
2 changed files with 76 additions and 0 deletions
72
index.d.ts
vendored
72
index.d.ts
vendored
|
|
@ -20,6 +20,74 @@ declare const enum LevelEnum {
|
||||||
TrueColor = 3
|
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 {
|
declare namespace chalk {
|
||||||
type Level = LevelEnum;
|
type Level = LevelEnum;
|
||||||
|
|
||||||
|
|
@ -306,6 +374,10 @@ This simply means that `chalk.red.yellow.green` is equivalent to `chalk.green`.
|
||||||
declare const chalk: chalk.Chalk & chalk.ChalkFunction & {
|
declare const chalk: chalk.Chalk & chalk.ChalkFunction & {
|
||||||
supportsColor: chalk.ColorSupport | false;
|
supportsColor: chalk.ColorSupport | false;
|
||||||
Level: typeof LevelEnum;
|
Level: typeof LevelEnum;
|
||||||
|
Color: Color;
|
||||||
|
ForegroundColor: ForegroundColor;
|
||||||
|
BackgroundColor: BackgroundColor;
|
||||||
|
Modifiers: Modifiers;
|
||||||
};
|
};
|
||||||
|
|
||||||
export = chalk;
|
export = chalk;
|
||||||
|
|
|
||||||
|
|
@ -139,3 +139,7 @@ expectType<string>(chalk.bgWhiteBright`foo`);
|
||||||
// -- Complex --
|
// -- Complex --
|
||||||
expectType<string>(chalk.red.bgGreen.underline('foo'));
|
expectType<string>(chalk.red.bgGreen.underline('foo'));
|
||||||
expectType<string>(chalk.underline.red.bgGreen('foo'));
|
expectType<string>(chalk.underline.red.bgGreen('foo'));
|
||||||
|
|
||||||
|
// -- Color types ==
|
||||||
|
expectType<typeof chalk.Color>('red');
|
||||||
|
expectError<typeof chalk.Color>('hotpink');
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue