roundel/picocolors

import picocolors from 'roundel/picocolors';
import { createColors, isColorSupported, module.exports } from 'roundel/picocolors';

FunctionsCopy Anchor Link

createColorsCopy Anchor Link

The styles, coloured or not. enabled defaults to {@link isColorSupported}.

function createColors(enabled?: boolean): Colors;

Returns Colors

ConstantsCopy Anchor Link

defaultCopy Anchor Link

The default export, declared as picocolors.

picocolors' module: the styles for this process, and createColors.

const picocolors: Colors & {
    createColors: typeof createColors;
};

isColorSupportedCopy Anchor Link

Whether picocolors would colour this process's output.

const isColorSupported: boolean;

module.exportsCopy Anchor Link

picocolors' module: the styles for this process, and createColors.

const picocolors: Colors & {
    createColors: typeof createColors;
};

TypesCopy Anchor Link

ColorsCopy Anchor Link

What createColors returns: whether colour is on, and every style.

type Colors = {
    isColorSupported: boolean;
} & Record<StyleName, Formatter>;

FormatterCopy Anchor Link

One style: the input, stringified, between an open and a close code.

type Formatter = (input: unknown) => string;