@sumup-oss/intl / resolveCurrencyFormat

Variable: resolveCurrencyFormat

const resolveCurrencyFormat: (...args) => NumberFormat | null

Defined in: lib/number-format/index.ts:383

Resolves the locale and collation options that are used to format a currency value.

Parameters

Parameter	Type
...args	[string | string[], string, NumberFormatOptions]

Returns

NumberFormat | null

Example

import { resolveCurrencyFormat } from '@sumup-oss/intl';

resolveCurrencyFormat('en-US', 'USD');
// {
//   'locale': 'en-US',
//   'numberingSystem': 'latn',
//   'style': 'currency',
//   'currency': 'USD',
//   'currencyDisplay': 'symbol',
//   'minimumIntegerDigits': 1,
//   'minimumFractionDigits': 2,
//   'maximumFractionDigits': 2,
//   'useGrouping': true,
//   'groupDelimiter': '.',
//   'decimalDelimiter': ',',
//   'currencySymbol': '$',
//   'currencyPosition': 'prefix',
// }

resolveCurrencyFormat('ja-JP', 'JPY');
// {
//   'locale': 'ja-JP',
//   'numberingSystem': 'latn',
//   'style': 'currency',
//   'currency': 'JPY',
//   'currencyDisplay': 'symbol',
//   'minimumIntegerDigits': 1,
//   'minimumFractionDigits': 0,
//   'maximumFractionDigits': 0,
//   'useGrouping': true,
//   'groupDelimiter': ',',
//   'decimalDelimiter': undefined,
//   'currencySymbol': '￥',
//   'currencyPosition': 'prefix',
// }

resolveCurrencyFormat('en-GB', 'GBP', { currencyDisplay: 'name' });
// {
//   'locale': 'en-GB',
//   'numberingSystem': 'latn',
//   'style': 'currency',
//   'currency': 'GBP',
//   'currencyDisplay': 'symbol',
//   'minimumIntegerDigits': 1,
//   'minimumFractionDigits': 2,
//   'maximumFractionDigits': 2,
//   'useGrouping': true,
//   'groupDelimiter': ',',
//   'decimalDelimiter': '.',
//   'currencySymbol': 'British pounds',
//   'currencyPosition': 'suffix',
// }

Remarks

When currency is omitted, it is inferred from the locale's region. This behavior is deprecated — always pass an explicit currency code.

For convenience, groupDelimiter,decimalDelimiter, currencySymbol, and currencyPosition are returned in addition to the Intl.ResolvedNumberFormatOptions.

In runtimes that don't support the Intl.NumberFormat.resolvedOptions API, null is returned.

The COP and HUF currencies are formatted without decimals.