Interface ChalkFunction

interface ChalkFunction {
    (text, ...placeholders): string;
    (...text): string;
}

Hierarchy (view full)

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

  • Parameters

    • Rest ...text: unknown[]

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc