Skip to content

vue-i18n / general / NumberOptions

Interface: NumberOptions<Key, Locales> ​

Number Options

Remarks ​

Options for Number formatting API

Vue I18n General ​

Extends ​

  • NumberFormatOptions.LocaleOptions<Locales>

Type Parameters ​

Type ParameterDefault type
Keystring
LocalesLocale

Properties ​

compactDisplay? ​

ts
optional compactDisplay: "long" | "short";

Inherited from ​

ts
Intl.NumberFormatOptions.compactDisplay

currency? ​

ts
optional currency: string;

Inherited from ​

ts
Intl.NumberFormatOptions.currency

currencyDisplay? ​

ts
optional currencyDisplay: keyof NumberFormatOptionsCurrencyDisplayRegistry;

Inherited from ​

ts
Intl.NumberFormatOptions.currencyDisplay

currencySign? ​

ts
optional currencySign: "standard" | "accounting";

Inherited from ​

ts
Intl.NumberFormatOptions.currencySign

fallbackWarn? ​

ts
optional fallbackWarn: boolean;

Remarks ​

Whether do resolve on format keys when your language lacks a formatting for a key


key? ​

ts
optional key: Key;

Remarks ​

The target format key


locale? ​

ts
optional locale: LocaleDetector<any[]> | Locales;

Remarks ​

The locale of localization

Inherited from ​

ts
LocaleOptions.locale

localeMatcher? ​

ts
optional localeMatcher: "lookup" | "best fit";

Inherited from ​

ts
Intl.NumberFormatOptions.localeMatcher

maximumFractionDigits? ​

ts
optional maximumFractionDigits: number;

Inherited from ​

ts
Intl.NumberFormatOptions.maximumFractionDigits

maximumSignificantDigits? ​

ts
optional maximumSignificantDigits: number;

Inherited from ​

ts
Intl.NumberFormatOptions.maximumSignificantDigits

minimumFractionDigits? ​

ts
optional minimumFractionDigits: number;

Inherited from ​

ts
Intl.NumberFormatOptions.minimumFractionDigits

minimumIntegerDigits? ​

ts
optional minimumIntegerDigits: number;

Inherited from ​

ts
Intl.NumberFormatOptions.minimumIntegerDigits

minimumSignificantDigits? ​

ts
optional minimumSignificantDigits: number;

Inherited from ​

ts
Intl.NumberFormatOptions.minimumSignificantDigits

missingWarn? ​

ts
optional missingWarn: boolean;

Remarks ​

Whether suppress warnings outputted when localization fails


notation? ​

ts
optional notation: "standard" | "scientific" | "engineering" | "compact";

Inherited from ​

ts
Intl.NumberFormatOptions.notation

numberingSystem? ​

ts
optional numberingSystem: string;

Inherited from ​

ts
Intl.NumberFormatOptions.numberingSystem

part? ​

ts
optional part: boolean;

Remarks ​

Whether to use Intel.NumberFormat#formatToParts


roundingIncrement? ​

ts
optional roundingIncrement: 1 | 2 | 5 | 10 | 20 | 25 | 50 | 100 | 200 | 250 | 500 | 1000 | 2000 | 2500 | 5000;

Inherited from ​

ts
Intl.NumberFormatOptions.roundingIncrement

roundingMode? ​

ts
optional roundingMode: 
  | "ceil"
  | "floor"
  | "expand"
  | "trunc"
  | "halfCeil"
  | "halfFloor"
  | "halfExpand"
  | "halfTrunc"
  | "halfEven";

Inherited from ​

ts
Intl.NumberFormatOptions.roundingMode

roundingPriority? ​

ts
optional roundingPriority: "auto" | "morePrecision" | "lessPrecision";

Inherited from ​

ts
Intl.NumberFormatOptions.roundingPriority

signDisplay? ​

ts
optional signDisplay: keyof NumberFormatOptionsSignDisplayRegistry;

Inherited from ​

ts
Intl.NumberFormatOptions.signDisplay

style? ​

ts
optional style: keyof NumberFormatOptionsStyleRegistry;

Inherited from ​

ts
Intl.NumberFormatOptions.style

trailingZeroDisplay? ​

ts
optional trailingZeroDisplay: "auto" | "stripIfInteger";

Inherited from ​

ts
Intl.NumberFormatOptions.trailingZeroDisplay

unit? ​

ts
optional unit: string;

Inherited from ​

ts
Intl.NumberFormatOptions.unit

unitDisplay? ​

ts
optional unitDisplay: "long" | "short" | "narrow";

Inherited from ​

ts
Intl.NumberFormatOptions.unitDisplay

useGrouping? ​

ts
optional useGrouping: boolean | keyof NumberFormatOptionsUseGroupingRegistry | "true" | "false";

Inherited from ​

ts
Intl.NumberFormatOptions.useGrouping

Released under the MIT License.