Skip to main content

Colors API

Basically this is an API for colorful console output in your scripts.

Usage​

const c = colors()
console.log('This is ' + c.red + 'red' + c.reset + ' text')

Reference​

Here is an object, returned by colors() function:

{
    colorsAvailable: boolean
    reset: string
    black: string
    darkRed: string
    darkGreen: string
    darkYellow: string
    darkBlue: string
    darkPurple: string
    darkCyan: string
    lightGray: string
    gray: string
    red: string
    green: string
    yellow: string
    blue: string
    purple: string
    cyan: string
    white: string
}

This is basic 16-color ANSI palette. If terminal supports it, object fields will contain ANSI escape sequences, otherwise they will be empty strings. colorsAvailable field indicates whether used terminal supports ANSI colors.