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

    Interface TimestampedArgs

    Optional args for MessageMaker.timestamped.

    2.0.0-beta.3

    interface TimestampedArgs {
        bold: boolean;
        clr: Colour | null;
        flag: boolean | "reverse";
        fullWidth: boolean;
        hangingIndent: string;
        indent: string;
        italic: boolean;
        joiner: string;
        linesIn: number;
        linesOut: number;
        maxWidth: number | null;
        minWidth: number;
        tab: string;
        time: Partial<
            Omit<
                MessageMaker.MsgArgs,
                | "depth"
                | "fullWidth"
                | "hangingIndent"
                | "indent"
                | "maxWidth"
                | "minWidth"
                | "tab",
            > & {
                date: Date;
                stamp: Partial<timestamp.Args>
                | RecursivePartial<timestamp.Args>;
            },
        >;
    }

    Hierarchy

    Index

    Properties

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

    Properties

    bold: boolean

    If true, applies bold font styles.

    false
    clr: Colour | null

    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
    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
    joiner: string

    Used to join bulk strings together.

    '\n\n'
    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: number | null

    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).

    '    '
    time: Partial<
        Omit<
            MessageMaker.MsgArgs,
            | "depth"
            | "fullWidth"
            | "hangingIndent"
            | "indent"
            | "maxWidth"
            | "minWidth"
            | "tab",
        > & {
            date: Date;
            stamp: Partial<timestamp.Args>
            | RecursivePartial<timestamp.Args>;
        },
    >

    Settings

    Member Visibility

    On This Page

    Properties