# Interface FormatOptions

Options supported by format.

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

#### Hierarchy (view full)

- FormatSettings
  - FormatOptions
    - FormatOptions

#####
Index

### Properties

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

##
Properties

### `Optional` currency

currency?: string

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

Inherited from FormatSettings.currency

### `Optional` dateFormat

dateFormat?: string

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

Inherited from FormatSettings.dateFormat

### format

format: string

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

### `Optional` fractionalDigits

fractionalDigits?: number

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

Inherited from FormatSettings.fractionalDigits

### `Optional` isDateOnly

isDateOnly?: boolean

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

### `Optional` locale

locale?: string

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

### `Optional` numberFormat

numberFormat?: string

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

Inherited from FormatSettings.numberFormat

### `Optional` timeFormat

timeFormat?: string

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

Inherited from FormatSettings.timeFormat

### `Optional` timeZone

timeZone?: string

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

Inherited from FormatSettings.timeZone