tsargp
    Preparing search index...

    Type Alias FormattingFlags

    The formatting flags.

    type FormattingFlags = {
        alt?: number;
        close?: string;
        custom?: FormattingCallback<any>;
        mergeNext?: boolean;
        mergePrev?: boolean;
        open?: string;
        sep?: string;
    }
    Index

    Properties

    alt? close? custom? mergeNext? mergePrev? open? sep?

    Properties

    alt?: number

    The phrase alternative, if any.

    close?: string

    A closing delimiter for array and object values. Overrides ConnectiveWords.arrayClose and ConnectiveWords.objectClose.

    custom?: FormattingCallback<any>

    A custom callback to format arguments.

    mergeNext?: boolean

    Whether the separator should be merged with the next value. (Defaults to false)

    mergePrev?: boolean

    Whether the separator should be merged with the previous value. (Defaults to true)

    open?: string

    An opening delimiter for array and object values. Overrides ConnectiveWords.arrayOpen and ConnectiveWords.objectOpen.

    sep?: string

    An element delimiter for array and object values. Overrides ConnectiveWords.arraySep and ConnectiveWords.objectSep.

    Settings

    Member Visibility

    On This Page

    Properties