FormatAmountParams

FormatAmountParams: Object

Options to format an amount.

Properties

amountnumberRequired

The original amount used for computation.

regionRegionInfoRequired

The region's details.

includeTaxesboolean

Whether the computed price should include taxes or not.

Default: true

minimumFractionDigitsnumber

The minimum number of fraction digits to use when formatting the price. This is passed as an option to Intl.NumberFormat in the underlying layer. You can learn more about this method’s options in MDN’s documentation.

maximumFractionDigitsnumber

The maximum number of fraction digits to use when formatting the price. This is passed as an option to Intl.NumberFormat which is used within the utility method. You can learn more about this method’s options in MDN’s documentation.

localestring

A BCP 47 language tag. The default value is en-US. This is passed as a first parameter to Intl.NumberFormat which is used within the utility method. You can learn more about this method’s parameters in MDN’s documentation.