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