Interface FormatOptions

Settings that affect how the features strings are formatted.

interface FormatOptions {
    currency?: string;
    dateFormat?: string;
    defaultExpressionValue?: string;
    format: string;
    fractionalDigits?: number;
    isDateOnly?: boolean;
    locale?: string;
    numberFormat?: string;
    timeFormat?: string;
    timeZone?: string;
}

Hierarchy (view full)

Properties

currency? dateFormat? defaultExpressionValue? format fractionalDigits? isDateOnly? locale? numberFormat? timeFormat? timeZone?

Properties

Optionalcurrency

currency?: string

The default unit of currency to use when formatting currency. See utilities/format/number!NumberSettings.currency.

OptionaldateFormat

dateFormat?: string

The default format to use when formatting dates. See utilities/format/date!DateFormatter.format.

OptionaldefaultExpressionValue

defaultExpressionValue?: string

The default string value for unevaluated expression values. Defaults to an empty string.

format

format: string

The string format. See utilities/format/string!StringFormatter.format.

OptionalfractionalDigits

fractionalDigits?: number

The default number of digits to show after the decimal point when formatting numbers. See utilities/format/number!NumberSettings.fractionalDigits.

OptionalisDateOnly

isDateOnly?: boolean

Indicates if a formatted date should be formatted without the time component even if the format suggests to include a time.

Optionallocale

locale?: string

The locale to use when formatting numbers and dates. If not specified, the current locale is used (see locale module).

OptionalnumberFormat

numberFormat?: string

The default format to use when formatting numbers. See utilities/format/number!NumberFormatter.format.

OptionaltimeFormat

timeFormat?: string

The default format to use when formatting times. See utilities/format/time!TimeFormatter.format.

OptionaltimeZone

timeZone?: string

The time zone of a date being formatted. See utilities/format/date!DateFormatter.timeZone.

Settings

Member Visibility

On This Page

Properties