# General Translation Platform: formatCurrency URL: https://generaltranslation.com/ru/docs/platform/core/reference/utility-functions/formatting/format-currency.mdx Docs index: https://generaltranslation.com/llms.txt Description: Форматирование значения Currency по локали без экземпляра GT. Справка по API для formatCurrency. [`formatCurrency`](/docs/platform/core/reference/gt-class-methods/formatting/format-currency) — это автономная вспомогательная функция из core library General Translation, которая форматирует числовое значение в локализованную строку валюты. Она представляет собой обёртку над встроенным API `Intl.NumberFormat` со стилем currency. ## Обзор [#overview] Импортируйте `formatCurrency` напрямую из `generaltranslation` и вызовите её, передав значение, код валюты и объект параметров. Для этого не требуется API-ключ или экземпляр [GT](/docs/platform/core/reference/gt-class/constructor). Если вам нужно форматирование через экземпляр с наследованием его локали, используйте метод [`formatCurrency`](/docs/platform/core/reference/gt-class-methods/formatting/format-currency) экземпляра [`GT`](/docs/platform/core/reference/gt-class/constructor). ```typescript import { formatCurrency } from 'generaltranslation'; const price = formatCurrency(1234.56, 'EUR', { locales: ['de-DE'] }); // "1.234,56 €" ``` Сигнатура: ```typescript formatCurrency( value: number, currency: string, options?: { locales?: string | string[] } & Intl.NumberFormatOptions ): string ``` ## Как это работает [#how-it-works] * **Базовый API.** Использует тот же [`Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) с `style: 'currency'`, что и метод класса GT. * **Выбор локали.** Если `locales` не указан, используется локаль библиотеки по умолчанию — `en`. * **Положение символа.** Символ валюты, разделители разрядов и формат десятичной части определяются выбранной локалью. ## Параметры [#parameters] | Параметр | Описание | Тип | Необязательный | По умолчанию | | ----------------------- | ------------------------------------------------------------ | ------------------------------------------------------------- | -------------- | ------------ | | [`value`](#value) | Числовое значение, которое нужно отформатировать. | `number` | Нет | — | | [`currency`](#currency) | Код валюты по стандарту ISO 4217, например `USD` или `EUR`. | `string` | Нет | — | | [`options`](#options) | Параметры форматирования, включая целевую локаль или локали. | `{ locales?: string \| string[] } & Intl.NumberFormatOptions` | Да | `{}` | ### `value` [#value] **Тип** `number` · **Обязательно** Числовое значение для форматирования. ### `currency` [#currency] **Тип** `string` · **Обязательно** Код валюты по стандарту ISO 4217, например `USD`, `EUR` или `JPY`. ### `options` [#options] **Тип** `{ locales?: string | string[] } & Intl.NumberFormatOptions` · **Необязательно** · **По умолчанию** `{}` Параметр форматирования. В таблице перечислены распространённые параметры валюты, доступные в опубликованных типах Ядра, и их фактические значения по умолчанию в Ядре. (Дополнительные сведения о стандарте и особенностях среды выполнения см. в [параметрах конструктора `Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options)). | Свойство | Описание | Тип | Необязательно | По умолчанию | | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------- | | `locales` | Локаль(и) для форматирования. | `string \| string[]` | Да | `en` | | `localeMatcher` | Алгоритм сопоставления локалей. | `'lookup' \| 'best fit'` | Да | `'best fit'` | | `numberingSystem` | Система нумерации, например `latn` или `arab`. | `string` | Да | `'latn'` | | `style` | Стиль форматирования чисел. `formatCurrency` задаёт стиль currency, если вы не переопределите его. | `'decimal' \| 'currency' \| 'percent' \| 'unit'` | Да | `'currency'` | | `currency` | Код валюты, используемый форматировщиком. Позиционный аргумент `currency` задаёт это значение, если вы не переопределите его. | `string` | Да | позиционный аргумент `currency` | | `currencyDisplay` | Как отображать валюту. | `'symbol' \| 'narrowSymbol' \| 'code' \| 'name'` | Да | `'symbol'` | | `currencySign` | Используемый знак валюты. | `'standard' \| 'accounting'` | Да | `'standard'` | | `unit` | Идентификатор единицы измерения. Обязательно, если `style` имеет значение `'unit'`. | `string` | Да | — | | `unitDisplay` | Как отображать единицу измерения. | `'short' \| 'narrow' \| 'long'` | Да | `'short'` | | `minimumFractionDigits` | Минимальное количество знаков в дробной части (0–100). | `number` | Да | количество знаков в дробной единице валюты; `0` при компактных настройках по умолчанию | | `maximumFractionDigits` | Максимальное количество знаков в дробной части (0–100), не меньше `minimumFractionDigits`. | `number` | Да | количество знаков в дробной единице валюты; `0` при компактных настройках по умолчанию | | `minimumSignificantDigits` | Минимальное количество значащих цифр (1–21), если активно округление по значащим цифрам. | `number` | Да | `1` | | `maximumSignificantDigits` | Максимальное количество значащих цифр (1–21), если активно округление по значащим цифрам. | `number` | Да | `21`; `2` при компактных настройках по умолчанию | | `roundingPriority` | Как взаимодействуют настройки дробных и значащих цифр. | `'auto' \| 'morePrecision' \| 'lessPrecision'` | Да | `'auto'`; `'morePrecision'` при компактных настройках по умолчанию | | `roundingMode` | Режим округления. | `'ceil' \| 'floor' \| 'expand' \| 'trunc' \| 'halfCeil' \| 'halfFloor' \| 'halfExpand' \| 'halfTrunc' \| 'halfEven'` | Да | `'halfExpand'` | | `roundingIncrement` | Шаг округления. Для значений, отличных от значения по умолчанию, требуется, чтобы фактическое минимальное и максимальное количество знаков в дробной части совпадали; такие значения нельзя сочетать с округлением по значащим цифрам или `roundingPriority`, отличным от `'auto'`. | `1 \| 2 \| 5 \| 10 \| 20 \| 25 \| 50 \| 100 \| 200 \| 250 \| 500 \| 1000 \| 2000 \| 2500 \| 5000` | Да | `1` | | `useGrouping` | Следует ли и когда использовать разделители групп разрядов. | `boolean \| 'always' \| 'auto' \| 'min2'` | Да | `'auto'`; `'min2'` при компактных настройках по умолчанию | | `notation` | Формат представления чисел. | `'standard' \| 'scientific' \| 'engineering' \| 'compact'` | Да | `'standard'` | | `compactDisplay` | Стиль отображения компактной нотации. | `'short' \| 'long'` | Да | `'short'` | | `signDisplay` | Когда отображать знак. | `'auto' \| 'never' \| 'always' \| 'exceptZero' \| 'negative'` | Да | `'auto'` | | `trailingZeroDisplay` | Следует ли отображать конечные нули. | `'auto' \| 'stripIfInteger'` | Да | `'auto'` | Если `notation: 'compact'` задан без параметров дробных или значащих цифр, по умолчанию используются следующие значения: `minimumFractionDigits: 0`, `maximumFractionDigits: 0`, `minimumSignificantDigits: 1` и `maximumSignificantDigits: 2`. В этом случае значение `roundingPriority` по умолчанию — `'morePrecision'`, а `useGrouping` — `'min2'`. При задании `style: 'unit'` также необходимо указать допустимую `unit`. ## Возвращаемое значение [#returns] **Тип** `string` Значение, отформатированное как локализованная строка валюты. ## Примеры [#examples] ```typescript import { formatCurrency } from 'generaltranslation'; // Доллары США console.log(formatCurrency(1234.56, 'USD', { locales: 'en-US' })); // Output: "$1,234.56" // Евро, немецкая локаль console.log(formatCurrency(1234.56, 'EUR', { locales: 'de-DE' })); // Output: "1.234,56 €" // Японская иена (без дробных знаков) console.log(formatCurrency(1234, 'JPY', { locales: 'ja-JP' })); // Output: "￥1,234" ``` ## Примечания [#notes] * Для корректного и предсказуемого вывода всегда явно указывайте значение `locales`. * Чтобы точнее настроить вывод, передавайте вместе с `locales` любые параметры `Intl.NumberFormatOptions` (например, `minimumFractionDigits`). ## Sitemap See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.