Utility TypeScript @ 2.0.0-beta
    Preparing search index...

    Interface MsgArgs

    Optional configuration for MessageMaker.msg.

    0.1.1

    interface MsgArgs {
        bold: boolean;
        clr: null | Colour;
        depth: number;
        flag: boolean | "reverse";
        fullWidth: boolean;
        hangingIndent: string;
        indent: string;
        italic: boolean;
        linesIn: number;
        linesOut: number;
        maxWidth: null | number;
        minWidth: number;
        tab: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    bold clr depth flag fullWidth hangingIndent indent italic linesIn linesOut maxWidth minWidth tab

    Properties

    bold: boolean

    If true, applies bold font styles.

    false
    clr: null | Colour

    Applies the given colour to the text.

    Default painter function for {@link MessageMaker.Args}.paintFormat options "html" and "markdown" do not currently support colours. To use colour with those outputs formats, you must provide your own {@link MessageMaker.Args}.painter argument.

    null
    depth: number

    If defined, an indent is added to every line. This is best for creating visual hierarchies. Indents count towards the {@link MessageMaker.MsgArgs}.maxWidth.

    Starts at zero (no indent).

    0
    flag: boolean | "reverse"

    Colours the message in the inverse -- clr is the background. If ``, the flag background should be solid black and the foreground is the chosen colour.

    false
    fullWidth: boolean

    Pads each line to be at least equal to {@link MessageMaker.MsgArgs}.maxWidth.

    Useful for flags that you want to take up a certain width.

    false
    hangingIndent: string

    String to be used as a hanging indent. Not painted.

    ''
    indent: string

    String to be used as an indent (every line). Not painted.

    ''
    italic: boolean

    If true, applies italic font styles.

    false
    linesIn: number

    Number of blank lines after the message, if any.

    0
    linesOut: number

    Number of blank lines after the message, if any.

    1
    maxWidth: null | number

    Max width of messages (in characters), if any.

    null
    minWidth: number

    Minimum width of messages (in characters).

    Minimum value is 10.

    20
    tab: string

    String used to represent a tab (e.g., with {@link MessageMaker.MsgArgs}.depth).

    '    '

    Settings

    Member Visibility

    On This Page

    Properties