Type alias FormattingFlags

FormattingFlags: {
    alt?: number;
    connectives?: ConnectiveWords;
    custom?: FormatCallback<any>;
    mergeNext?: boolean;
    mergePrev?: boolean;
    sep?: string;
}

The formatting flags.

Type declaration

  • Optional Readonly alt?: number

    The phrase alternative, if any.

  • Optional Readonly connectives?: ConnectiveWords

    The connective words.

  • Optional Readonly custom?: FormatCallback<any>

    A custom callback to format arguments.

  • Optional Readonly mergeNext?: boolean

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

  • Optional Readonly mergePrev?: boolean

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

  • Optional Readonly sep?: string

    An element separator for array values.