roundel/tokens

import { sgr, error, warn, … } from 'roundel/tokens';

FunctionsCopy Anchor Link

sgrCopy Anchor Link

Wrap s in a chain of SGR pairs, outermost first, as chalk does: a close already inside s is followed by a re-open so a nested style survives it, and every line break closes before it and re-opens after (chalk/chalk#92). The façade computes parameters; the escape itself is emitted here and nowhere else (R3, R6).

function sgr(chain: readonly SgrPair[], s: string): string;

Returns string

ConstantsCopy Anchor Link

commandCopy Anchor Link

const command: Token;

errorCopy Anchor Link

const error: Token;

flagCopy Anchor Link

const flag: Token;

headingCopy Anchor Link

const heading: Token;

hintCopy Anchor Link

const hint: Token;

mutedCopy Anchor Link

const muted: Token;

okCopy Anchor Link

const ok: Token;

valueCopy Anchor Link

const value: Token;

warnCopy Anchor Link

const warn: Token;

InterfacesCopy Anchor Link

SgrPairCopy Anchor Link

One SGR pair as the chalk façade composes them: the parameters that open and close it, no escape.

interface SgrPair {
    readonly open: string;
    readonly close: string;
}

TypesCopy Anchor Link

TokenCopy Anchor Link

type Token = (s: string) => string;