Interface Args

Optional configuration for MessageMaker.

0.1.1

interface Args {
    ansiColours: AnsiColours;
    msg: MessageMaker.MsgArgs;
    painter: ((line: string, args?: Partial<PainterArgs>) => string) | null;
    paintFormat: "node" | "html" | "markdown" | null;
    paintIfEmpty: boolean;
}

Properties

ansiColours: AnsiColours

Ansi colour codes for the default node {@link MessageMaker.Args}.painter function.

Default arguments for MessageMaker.msg. Merged with the default value recursively.

painter: ((line: string, args?: Partial<PainterArgs>) => string) | null

Function used to apply formatting to the messages.

paintFormat: "node" | "html" | "markdown" | null

Defines the default {@link MessageMaker.Args}.painter value.

null

paintIfEmpty: boolean

Whether even empty strings (or strings with only spaces) should be painted with MessageMaker.painter.

false