Variable colors

Type declaration

• BackgroundColor: BackgroundColor

• Color: Color

• ForegroundColor: ForegroundColor

• Instance: default.Instance

  Return a new Chalk instance.

• Level: default.Level

• Modifiers: Modifiers

• Readonly bgBlack: default.Chalk

• Readonly bgBlackBright: default.Chalk

• Readonly bgBlue: default.Chalk

• Readonly bgBlueBright: default.Chalk

• Readonly bgCyan: default.Chalk

• Readonly bgCyanBright: default.Chalk

• Readonly bgGray: default.Chalk

• Readonly bgGreen: default.Chalk

• Readonly bgGreenBright: default.Chalk

• Readonly bgGrey: default.Chalk

• Readonly bgMagenta: default.Chalk

• Readonly bgMagentaBright: default.Chalk

• Readonly bgRed: default.Chalk

• Readonly bgRedBright: default.Chalk

• Readonly bgWhite: default.Chalk

• Readonly bgWhiteBright: default.Chalk

• Readonly bgYellow: default.Chalk

• Readonly bgYellowBright: default.Chalk

• Readonly black: default.Chalk

• Readonly blackBright: default.Chalk

• Readonly blue: default.Chalk

• Readonly blueBright: default.Chalk

• Readonly bold: default.Chalk

  Modifier: Make text bold.

• Readonly cyan: default.Chalk

• Readonly cyanBright: default.Chalk

• Readonly dim: default.Chalk

  Modifier: Emitting only a small amount of light.

• Readonly gray: default.Chalk

• Readonly green: default.Chalk

• Readonly greenBright: default.Chalk

• Readonly grey: default.Chalk

• Readonly hidden: default.Chalk

  Modifier: Prints the text, but makes it invisible.

• Readonly inverse: default.Chalk

  Modifier: Inverse background and foreground colors.

• Readonly italic: default.Chalk

  Modifier: Make text italic. (Not widely supported)

• 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: default.Chalk

• Readonly magentaBright: default.Chalk

• Readonly red: default.Chalk

• Readonly redBright: default.Chalk

• Readonly reset: default.Chalk

  Modifier: Resets the current color chain.

• stderr: default.Chalk & {
      supportsColor: false | default.ColorSupport;
  }

• Readonly strikethrough: default.Chalk

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

• supportsColor: false | default.ColorSupport

• Readonly underline: default.Chalk

  Modifier: Make text underline. (Not widely supported)

• Readonly 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: default.Chalk

• Readonly whiteBright: default.Chalk

• Readonly yellow: default.Chalk

• Readonly yellowBright: default.Chalk

• default:function

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

  • 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.

    Parameters

    • text: TemplateStringsArray

    • Rest ...placeholders: unknown[]

    Returns string

  • default(...text: unknown[]): string

  • 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.

    Parameters

    • Rest ...text: unknown[]

    Returns string

• ansi:function

  • 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

• ansi256:function

  • ansi256(index: number): default.Chalk

  • Use a 8-bit unsigned number to set text color.

    Parameters

    • index: number

    Returns default.Chalk

• bgAnsi:function

  • 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

• bgAnsi256:function

  • bgAnsi256(index: number): default.Chalk

  • Use a 8-bit unsigned number to set background color.

    Parameters

    • index: number

    Returns default.Chalk

• bgHex:function

  • 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

• bgHsl:function

  • 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

• bgHsv:function

  • 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

• bgHwb:function

  • 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

• bgKeyword:function

  • 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

• bgRgb:function

  • 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

• hex:function

  • 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

• hsl:function

  • 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

• hsv:function

  • 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

• hwb:function

  • 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

• keyword:function

  • 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

• rgb:function

  • 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