Interface Chalk

interface Chalk {
    Instance: colors.Instance;
    bgBlack: colors.Chalk;
    bgBlackBright: colors.Chalk;
    bgBlue: colors.Chalk;
    bgBlueBright: colors.Chalk;
    bgCyan: colors.Chalk;
    bgCyanBright: colors.Chalk;
    bgGray: colors.Chalk;
    bgGreen: colors.Chalk;
    bgGreenBright: colors.Chalk;
    bgGrey: colors.Chalk;
    bgMagenta: colors.Chalk;
    bgMagentaBright: colors.Chalk;
    bgRed: colors.Chalk;
    bgRedBright: colors.Chalk;
    bgWhite: colors.Chalk;
    bgWhiteBright: colors.Chalk;
    bgYellow: colors.Chalk;
    bgYellowBright: colors.Chalk;
    black: colors.Chalk;
    blackBright: colors.Chalk;
    blue: colors.Chalk;
    blueBright: colors.Chalk;
    bold: colors.Chalk;
    cyan: colors.Chalk;
    cyanBright: colors.Chalk;
    dim: colors.Chalk;
    gray: colors.Chalk;
    green: colors.Chalk;
    greenBright: colors.Chalk;
    grey: colors.Chalk;
    hidden: colors.Chalk;
    inverse: colors.Chalk;
    italic: colors.Chalk;
    level: colors.Level;
    magenta: colors.Chalk;
    magentaBright: colors.Chalk;
    red: colors.Chalk;
    redBright: colors.Chalk;
    reset: colors.Chalk;
    strikethrough: colors.Chalk;
    underline: colors.Chalk;
    visible: colors.Chalk;
    white: colors.Chalk;
    whiteBright: colors.Chalk;
    yellow: colors.Chalk;
    yellowBright: colors.Chalk;
    ansi(code): colors.Chalk;
    ansi256(index): colors.Chalk;
    bgAnsi(code): colors.Chalk;
    bgAnsi256(index): colors.Chalk;
    bgHex(color): colors.Chalk;
    bgHsl(hue, saturation, lightness): colors.Chalk;
    bgHsv(hue, saturation, value): colors.Chalk;
    bgHwb(hue, whiteness, blackness): colors.Chalk;
    bgKeyword(color): colors.Chalk;
    bgRgb(red, green, blue): colors.Chalk;
    hex(color): colors.Chalk;
    hsl(hue, saturation, lightness): colors.Chalk;
    hsv(hue, saturation, value): colors.Chalk;
    hwb(hue, whiteness, blackness): colors.Chalk;
    keyword(color): colors.Chalk;
    rgb(red, green, blue): colors.Chalk;
    (text, ...placeholders): string;
    (...text): string;
}

Hierarchy (view full)

  • Chalk(text, ...placeholders): string

  • Use a template string.

    Parameters

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

    Returns 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}}`)
  • Chalk(...text): string

  • Parameters

    • Rest ...text: unknown[]

    Returns string

Properties

Instance bgBlack bgBlackBright bgBlue bgBlueBright bgCyan bgCyanBright bgGray bgGreen bgGreenBright bgGrey bgMagenta bgMagentaBright bgRed bgRedBright bgWhite bgWhiteBright bgYellow bgYellowBright black blackBright blue blueBright bold cyan cyanBright dim gray green greenBright grey hidden inverse italic level magenta magentaBright red redBright reset strikethrough underline visible white whiteBright yellow yellowBright

Methods

ansi ansi256 bgAnsi bgAnsi256 bgHex bgHsl bgHsv bgHwb bgKeyword bgRgb hex hsl hsv hwb keyword rgb

Properties

Instance

Instance: colors.Instance

Return a new Chalk instance.

Readonly bgBlack

bgBlack: colors.Chalk

Readonly bgBlackBright

bgBlackBright: colors.Chalk

Readonly bgBlue

bgBlue: colors.Chalk

Readonly bgBlueBright

bgBlueBright: colors.Chalk

Readonly bgCyan

bgCyan: colors.Chalk

Readonly bgCyanBright

bgCyanBright: colors.Chalk

Readonly bgGray

bgGray: colors.Chalk

Readonly bgGreen

bgGreen: colors.Chalk

Readonly bgGreenBright

bgGreenBright: colors.Chalk

Readonly bgGrey

bgGrey: colors.Chalk

Readonly bgMagenta

bgMagenta: colors.Chalk

Readonly bgMagentaBright

bgMagentaBright: colors.Chalk

Readonly bgRed

bgRed: colors.Chalk

Readonly bgRedBright

bgRedBright: colors.Chalk

Readonly bgWhite

bgWhite: colors.Chalk

Readonly bgWhiteBright

bgWhiteBright: colors.Chalk

Readonly bgYellow

bgYellow: colors.Chalk

Readonly bgYellowBright

bgYellowBright: colors.Chalk

Readonly black

black: colors.Chalk

Readonly blackBright

blackBright: colors.Chalk

Readonly blue

blue: colors.Chalk

Readonly blueBright

blueBright: colors.Chalk

Readonly bold

bold: colors.Chalk

Modifier: Make text bold.

Readonly cyan

cyan: colors.Chalk

Readonly cyanBright

cyanBright: colors.Chalk

Readonly dim

dim: colors.Chalk

Modifier: Emitting only a small amount of light.

Readonly gray

gray: colors.Chalk

Readonly green

green: colors.Chalk

Readonly greenBright

greenBright: colors.Chalk

Readonly grey

grey: colors.Chalk

Readonly hidden

hidden: colors.Chalk

Modifier: Prints the text, but makes it invisible.

Readonly inverse

inverse: colors.Chalk

Modifier: Inverse background and foreground colors.

Readonly italic

italic: colors.Chalk

Modifier: Make text italic. (Not widely supported)

level

level: colors.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: colors.Chalk

Readonly magentaBright

magentaBright: colors.Chalk

Readonly red

red: colors.Chalk

Readonly redBright

redBright: colors.Chalk

Readonly reset

reset: colors.Chalk

Modifier: Resets the current color chain.

Readonly strikethrough

strikethrough: colors.Chalk

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

Readonly underline

underline: colors.Chalk

Modifier: Make text underline. (Not widely supported)

Readonly visible

visible: colors.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: colors.Chalk

Readonly whiteBright

whiteBright: colors.Chalk

Readonly yellow

yellow: colors.Chalk

Readonly yellowBright

yellowBright: colors.Chalk

Methods

ansi

ansi256

bgAnsi

  • bgAnsi(code): colors.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 colors.Chalk

bgAnsi256

bgHex

  • bgHex(color): colors.Chalk

  • Use HEX value to set background color.

    Parameters

    • color: string

      Hexadecimal value representing the desired color.

    Returns colors.Chalk

    Example

    import chalk = require('chalk');

    chalk.bgHex('#DEADED');

bgHsl

  • bgHsl(hue, saturation, lightness): colors.Chalk

  • Use HSL values to set background color.

    Parameters

    • hue: number
    • saturation: number
    • lightness: number

    Returns colors.Chalk

bgHsv

  • bgHsv(hue, saturation, value): colors.Chalk

  • Use HSV values to set background color.

    Parameters

    • hue: number
    • saturation: number
    • value: number

    Returns colors.Chalk

bgHwb

  • bgHwb(hue, whiteness, blackness): colors.Chalk

  • Use HWB values to set background color.

    Parameters

    • hue: number
    • whiteness: number
    • blackness: number

    Returns colors.Chalk

bgKeyword

  • bgKeyword(color): colors.Chalk

  • Use keyword color value to set background color.

    Parameters

    • color: string

      Keyword value representing the desired color.

    Returns colors.Chalk

    Example

    import chalk = require('chalk');

    chalk.bgKeyword('orange');

bgRgb

  • bgRgb(red, green, blue): colors.Chalk

  • Use RGB values to set background color.

    Parameters

    • red: number
    • green: number
    • blue: number

    Returns colors.Chalk

hex

  • hex(color): colors.Chalk

  • Use HEX value to set text color.

    Parameters

    • color: string

      Hexadecimal value representing the desired color.

    Returns colors.Chalk

    Example

    import chalk = require('chalk');

    chalk.hex('#DEADED');

hsl

  • hsl(hue, saturation, lightness): colors.Chalk

  • Use HSL values to set text color.

    Parameters

    • hue: number
    • saturation: number
    • lightness: number

    Returns colors.Chalk

hsv

  • hsv(hue, saturation, value): colors.Chalk

  • Use HSV values to set text color.

    Parameters

    • hue: number
    • saturation: number
    • value: number

    Returns colors.Chalk

hwb

  • hwb(hue, whiteness, blackness): colors.Chalk

  • Use HWB values to set text color.

    Parameters

    • hue: number
    • whiteness: number
    • blackness: number

    Returns colors.Chalk

keyword

  • keyword(color): colors.Chalk

  • Use keyword color value to set text color.

    Parameters

    • color: string

      Keyword value representing the desired color.

    Returns colors.Chalk

    Example

    import chalk = require('chalk');

    chalk.keyword('orange');

rgb

  • rgb(red, green, blue): colors.Chalk

  • Use RGB values to set text color.

    Parameters

    • red: number
    • green: number
    • blue: number

    Returns colors.Chalk

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc