Interface Chalk

Hierarchy

default.ChalkFunction
- Chalk

Chalk(text: TemplateStringsArray, ...placeholders: unknown[]): string

Use a template string.

Remarks

Template literals are unsupported for nested calls (see issue #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}}`)

Parameters

text: TemplateStringsArray
Rest ...placeholders: unknown[]

Returns string

Chalk(...text: unknown[]): string
Parameters
- Rest ...text: unknown[]
Returns string
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:150

References

bold

Re-exports bold

Properties

Instance

Instance: default.Instance

Return a new Chalk instance.

`Readonly` bgBlack

bgBlack: default.Chalk

`Readonly` bgBlackBright

bgBlackBright: default.Chalk

`Readonly` bgBlue

bgBlue: default.Chalk

`Readonly` bgBlueBright

bgBlueBright: default.Chalk

`Readonly` bgCyan

bgCyan: default.Chalk

`Readonly` bgCyanBright

bgCyanBright: default.Chalk

`Readonly` bgGray

bgGray: default.Chalk

`Readonly` bgGreen

bgGreen: default.Chalk

`Readonly` bgGreenBright

bgGreenBright: default.Chalk

`Readonly` bgGrey

bgGrey: default.Chalk

`Readonly` bgMagenta

bgMagenta: default.Chalk

`Readonly` bgMagentaBright

bgMagentaBright: default.Chalk

`Readonly` bgRed

bgRed: default.Chalk

`Readonly` bgRedBright

bgRedBright: default.Chalk

`Readonly` bgWhite

bgWhite: default.Chalk

`Readonly` bgWhiteBright

bgWhiteBright: default.Chalk

`Readonly` bgYellow

bgYellow: default.Chalk

`Readonly` bgYellowBright

bgYellowBright: default.Chalk

`Readonly` black

black: default.Chalk

`Readonly` blackBright

blackBright: default.Chalk

`Readonly` blue

blue: default.Chalk

`Readonly` blueBright

blueBright: default.Chalk

`Readonly` cyan

cyan: default.Chalk

`Readonly` cyanBright

cyanBright: default.Chalk

`Readonly` dim

dim: default.Chalk

Modifier: Emitting only a small amount of light.

`Readonly` gray

gray: default.Chalk

`Readonly` green

green: default.Chalk

`Readonly` greenBright

greenBright: default.Chalk

`Readonly` grey

grey: default.Chalk

`Readonly` hidden

hidden: default.Chalk

Modifier: Prints the text, but makes it invisible.

`Readonly` inverse

inverse: default.Chalk

Modifier: Inverse background and foreground colors.

`Readonly` italic

italic: default.Chalk

Modifier: Make text italic. (Not widely supported)

level

level: default.Level

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.

`Readonly` magenta

magenta: default.Chalk

`Readonly` magentaBright

magentaBright: default.Chalk

Modifier: Resets the current color chain.

`Readonly` strikethrough

strikethrough: default.Chalk

Modifier: Puts a horizontal line through the center of the text. (Not widely supported)

`Readonly` underline

underline: default.Chalk

Modifier: Make text underline. (Not widely supported)

`Readonly` visible

visible: default.Chalk

Modifier: Prints the text only when Chalk has a color support level > 0. Can be useful for things that are purely cosmetic.

`Readonly` white

white: default.Chalk

`Readonly` whiteBright

whiteBright: default.Chalk

`Readonly` yellow

yellow: default.Chalk

`Readonly` yellowBright

yellowBright: default.Chalk

Methods

ansi

ansi(code: number): default.Chalk
Use a Select/Set Graphic Rendition (SGR) color code number to set text color.

30 <= code && code < 38 || 90 <= code && code < 98 For example, 31 for red, 91 for redBright.
Parameters
- code: number
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:226

ansi256

ansi256(index: number): default.Chalk
Use a 8-bit unsigned number to set text color.
Parameters
- index: number
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:231

bgAnsi

bgAnsi(code: number): default.Chalk
Use a Select/Set Graphic Rendition (SGR) color code number 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).
Parameters
- code: number
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:288

bgAnsi256

bgAnsi256(index: number): default.Chalk
Use a 8-bit unsigned number to set background color.
Parameters
- index: number
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:293

bgHex

bgHex(color: string): default.Chalk
Use HEX value to set background color.

Example
```
import chalk = require('chalk');

chalk.bgHex('#DEADED');
```
Parameters
- color: string
  
  Hexadecimal value representing the desired color.
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:245

bgHsl

bgHsl(hue: number, saturation: number, lightness: number): default.Chalk
Use HSL values to set background color.
Parameters
- hue: number
- saturation: number
- lightness: number
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:269

bgHsv

bgHsv(hue: number, saturation: number, value: number): default.Chalk
Use HSV values to set background color.
Parameters
- hue: number
- saturation: number
- value: number
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:274

bgHwb

bgHwb(hue: number, whiteness: number, blackness: number): default.Chalk
Use HWB values to set background color.
Parameters
- hue: number
- whiteness: number
- blackness: number
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:279

bgKeyword

bgKeyword(color: string): default.Chalk
Use keyword color value to set background color.

Example
```
import chalk = require('chalk');

chalk.bgKeyword('orange');
```
Parameters
- color: string
  
  Keyword value representing the desired color.
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:259

bgRgb

bgRgb(red: number, green: number, blue: number): default.Chalk
Use RGB values to set background color.
Parameters
- red: number
- green: number
- blue: number
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:264

hex

hex(color: string): default.Chalk
Use HEX value to set text color.

Example
```
import chalk = require('chalk');

chalk.hex('#DEADED');
```
Parameters
- color: string
  
  Hexadecimal value representing the desired color.
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:184

hsl

hsl(hue: number, saturation: number, lightness: number): default.Chalk
Use HSL values to set text color.
Parameters
- hue: number
- saturation: number
- lightness: number
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:208

hsv

hsv(hue: number, saturation: number, value: number): default.Chalk
Use HSV values to set text color.
Parameters
- hue: number
- saturation: number
- value: number
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:213

hwb

hwb(hue: number, whiteness: number, blackness: number): default.Chalk
Use HWB values to set text color.
Parameters
- hue: number
- whiteness: number
- blackness: number
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:218

keyword

keyword(color: string): default.Chalk
Use keyword color value to set text color.

Example
```
import chalk = require('chalk');

chalk.keyword('orange');
```
Parameters
- color: string
  
  Keyword value representing the desired color.
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:198

rgb

rgb(red: number, green: number, blue: number): default.Chalk
Use RGB values to set text color.
Parameters
- red: number
- green: number
- blue: number
Returns default.Chalk
- Defined in node_modules/.pnpm/chalk@4.1.2/node_modules/chalk/index.d.ts:203

Interface Chalk

Hierarchy

Remarks

Example

Example

Parameters

text: TemplateStringsArray

Rest ...placeholders: unknown[]

Returns string

Parameters

Rest ...text: unknown[]

Returns string

Index

References

Properties

Methods

References

bold

Properties

Instance

Readonly bgBlack

Readonly bgBlackBright

Readonly bgBlue

Readonly bgBlueBright

Readonly bgCyan

Readonly bgCyanBright

Readonly bgGray

Readonly bgGreen

Readonly bgGreenBright

Readonly bgGrey

Readonly bgMagenta

Readonly bgMagentaBright

Readonly bgRed

Readonly bgRedBright

Readonly bgWhite

Readonly bgWhiteBright

Readonly bgYellow

Readonly bgYellowBright

Readonly black

Readonly blackBright

Readonly blue

Readonly blueBright

Readonly cyan

Readonly cyanBright

Readonly dim

Readonly gray

Readonly green

Readonly greenBright

Readonly grey

Readonly hidden

Readonly inverse

Readonly italic

level

Readonly magenta

Readonly magentaBright

Readonly red

Readonly redBright

Readonly reset

Readonly strikethrough

Readonly underline

Readonly visible

Readonly white

Readonly whiteBright

Readonly yellow

Readonly yellowBright

Methods

ansi

Parameters

code: number

Returns default.Chalk

ansi256

Parameters

index: number

Returns default.Chalk

bgAnsi

Parameters

code: number

Returns default.Chalk

bgAnsi256

Parameters

`Rest` ...placeholders: unknown[]

`Rest` ...text: unknown[]

`Readonly` bgBlack

`Readonly` bgBlackBright

`Readonly` bgBlue

`Readonly` bgBlueBright

`Readonly` bgCyan

`Readonly` bgCyanBright

`Readonly` bgGray

`Readonly` bgGreen

`Readonly` bgGreenBright

`Readonly` bgGrey

`Readonly` bgMagenta

`Readonly` bgMagentaBright

`Readonly` bgRed

`Readonly` bgRedBright

`Readonly` bgWhite

`Readonly` bgWhiteBright

`Readonly` bgYellow

`Readonly` bgYellowBright

`Readonly` black

`Readonly` blackBright

`Readonly` blue

`Readonly` blueBright

`Readonly` cyan

`Readonly` cyanBright

`Readonly` dim

`Readonly` gray

`Readonly` green

`Readonly` greenBright

`Readonly` grey

`Readonly` hidden

`Readonly` inverse

`Readonly` italic

`Readonly` magenta

`Readonly` magentaBright

`Readonly` red

`Readonly` redBright

`Readonly` reset

`Readonly` strikethrough

`Readonly` underline

`Readonly` visible

`Readonly` white

`Readonly` whiteBright

`Readonly` yellow

`Readonly` yellowBright