# General Translation Platform: formatCurrency
URL: https://generaltranslation.com/es/docs/platform/core/reference/utility-functions/formatting/format-currency.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: Formatea un valor monetario según la configuración regional sin una instancia de GT. Referencia de la API de formatCurrency.

[`formatCurrency`](/docs/platform/core/reference/gt-class-methods/formatting/format-currency) es una función de utilidad independiente de la biblioteca Core de General Translation que formatea un valor numérico como una cadena monetaria localizada. Envuelve la API integrada `Intl.NumberFormat` con el estilo de moneda.

## Descripción general [#overview]

Importa `formatCurrency` directamente desde `generaltranslation` y llámalo con un valor, un código de moneda y un objeto de opciones. No requiere una clave de API ni una instancia de [GT](/docs/platform/core/reference/gt-class/constructor). Si quieres un formato basado en instancias que herede la configuración regional de la instancia, usa en su lugar el método [`formatCurrency`](/docs/platform/core/reference/gt-class-methods/formatting/format-currency) de una instancia de [`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 €"
```

Firma:

```typescript
formatCurrency(
  value: number,
  currency: string,
  options?: { locales?: string | string[] } & Intl.NumberFormatOptions
): string
```

## Cómo funciona [#how-it-works]

* **API subyacente.** Usa el mismo [`Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) con `style: 'currency'` que el método de la clase GT.
* **Resolución de la configuración regional.** Cuando se omite `locales`, recurre a la configuración regional predeterminada de la biblioteca, `en`.
* **Posición del símbolo.** El símbolo de moneda, los separadores de agrupación y el formato decimal siguen la configuración regional resuelta.

## Parámetros [#parameters]

| Parámetro               | Descripción                                                                    | Tipo                                                          | Opcional | Predeterminado |
| ----------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------- | -------- | -------------- |
| [`value`](#value)       | El valor numérico que se va a formatear.                                       | `number`                                                      | No       | —              |
| [`currency`](#currency) | El código de divisa ISO 4217, como `USD` o `EUR`.                            | `string`                                                      | No       | —              |
| [`options`](#options)   | Configuración de formato, incluidas las configuraciones regionales de destino. | `{ locales?: string \| string[] } & Intl.NumberFormatOptions` | Sí       | `{}`           |

### `value` [#value]

**Tipo** `number` · **Obligatorio**

El valor numérico que se va a formatear.

### `currency` [#currency]

**Type** `string` · **Obligatorio**

El código de divisa ISO 4217, como `USD`, `EUR` o `JPY`.

### `options` [#options]

**Tipo** `{ locales?: string | string[] } & Intl.NumberFormatOptions` · **Opcional** · **Predeterminado** `{}`

Configuración de formato. La tabla enumera las opciones de divisa habituales expuestas por los tipos publicados de Core y sus valores predeterminados efectivos en Core. (Consulta las [opciones del constructor `Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#options) para obtener información adicional sobre los estándares y detalles específicos del runtime).

| Propiedad                  | Descripción                                                                                                                                                                                                                                                                       | Tipo                                                                                                                 | Opcional | Predeterminado                                                                     |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------- |
| `locales`                  | Configuración regional para el formato.                                                                                                                                                                                                                                           | `string \| string[]`                                                                                                 | Sí       | `en`                                                                               |
| `localeMatcher`            | Algoritmo de coincidencia de configuración regional.                                                                                                                                                                                                                              | `'lookup' \| 'best fit'`                                                                                             | Sí       | `'best fit'`                                                                       |
| `numberingSystem`          | Sistema de numeración, como `latn` o `arab`.                                                                                                                                                                                                                                      | `string`                                                                                                             | Sí       | `'latn'`                                                                           |
| `style`                    | Estilo de formato numérico. `formatCurrency` aplica el estilo de divisa, salvo que lo reemplaces.                                                                                                                                                                                 | `'decimal' \| 'currency' \| 'percent' \| 'unit'`                                                                     | Sí       | `'currency'`                                                                       |
| `currency`                 | Código de divisa ISO 4217 utilizado por el formateador. El argumento posicional `currency` proporciona este valor, salvo que lo reemplaces.                                                                                                                                       | `string`                                                                                                             | Sí       | argumento posicional `currency`                                                    |
| `currencyDisplay`          | Cómo mostrar la divisa.                                                                                                                                                                                                                                                           | `'symbol' \| 'narrowSymbol' \| 'code' \| 'name'`                                                                     | Sí       | `'symbol'`                                                                         |
| `currencySign`             | Signo de divisa que se utilizará.                                                                                                                                                                                                                                                 | `'standard' \| 'accounting'`                                                                                         | Sí       | `'standard'`                                                                       |
| `unit`                     | Identificador de unidad. Obligatorio cuando `style` es `'unit'`.                                                                                                                                                                                                                  | `string`                                                                                                             | Sí       | —                                                                                  |
| `unitDisplay`              | Cómo mostrar la unidad.                                                                                                                                                                                                                                                           | `'short' \| 'narrow' \| 'long'`                                                                                      | Sí       | `'short'`                                                                          |
| `minimumFractionDigits`    | Número mínimo de dígitos fraccionarios (0–100).                                                                                                                                                                                                                                   | `number`                                                                                                             | Sí       | dígitos de la unidad menor de la divisa; `0` con valores predeterminados compactos |
| `maximumFractionDigits`    | Número máximo de dígitos fraccionarios (0–100), como mínimo `minimumFractionDigits`.                                                                                                                                                                                              | `number`                                                                                                             | Sí       | dígitos de la unidad menor de la divisa; `0` con valores predeterminados compactos |
| `minimumSignificantDigits` | Número mínimo de dígitos significativos (1–21), cuando está activo el redondeo por dígitos significativos.                                                                                                                                                                        | `number`                                                                                                             | Sí       | `1`                                                                                |
| `maximumSignificantDigits` | Número máximo de dígitos significativos (1–21), cuando está activo el redondeo por dígitos significativos.                                                                                                                                                                        | `number`                                                                                                             | Sí       | `21`; `2` con valores predeterminados compactos                                    |
| `roundingPriority`         | Cómo interactúan los ajustes de dígitos fraccionarios y significativos.                                                                                                                                                                                                           | `'auto' \| 'morePrecision' \| 'lessPrecision'`                                                                       | Sí       | `'auto'`; `'morePrecision'` con valores predeterminados compactos                  |
| `roundingMode`             | Modo de redondeo.                                                                                                                                                                                                                                                                 | `'ceil' \| 'floor' \| 'expand' \| 'trunc' \| 'halfCeil' \| 'halfFloor' \| 'halfExpand' \| 'halfTrunc' \| 'halfEven'` | Sí       | `'halfExpand'`                                                                     |
| `roundingIncrement`        | Incremento de redondeo. Los valores distintos del predeterminado requieren que los números efectivos mínimo y máximo de dígitos fraccionarios sean iguales y no se pueden combinar con el redondeo por dígitos significativos ni con una `roundingPriority` distinta de `'auto'`. | `1 \| 2 \| 5 \| 10 \| 20 \| 25 \| 50 \| 100 \| 200 \| 250 \| 500 \| 1000 \| 2000 \| 2500 \| 5000`                    | Sí       | `1`                                                                                |
| `useGrouping`              | Si se deben usar separadores de agrupación y cuándo.                                                                                                                                                                                                                              | `boolean \| 'always' \| 'auto' \| 'min2'`                                                                            | Sí       | `'auto'`; `'min2'` con valores predeterminados compactos                           |
| `notation`                 | Formato de notación numérica.                                                                                                                                                                                                                                                     | `'standard' \| 'scientific' \| 'engineering' \| 'compact'`                                                           | Sí       | `'standard'`                                                                       |
| `compactDisplay`           | Estilo de visualización de la notación compacta.                                                                                                                                                                                                                                  | `'short' \| 'long'`                                                                                                  | Sí       | `'short'`                                                                          |
| `signDisplay`              | Cuándo mostrar el signo.                                                                                                                                                                                                                                                          | `'auto' \| 'never' \| 'always' \| 'exceptZero' \| 'negative'`                                                        | Sí       | `'auto'`                                                                           |
| `trailingZeroDisplay`      | Si se deben mostrar los ceros finales.                                                                                                                                                                                                                                            | `'auto' \| 'stripIfInteger'`                                                                                         | Sí       | `'auto'`                                                                           |

Cuando se establece `notation: 'compact'` sin ninguna opción de dígitos fraccionarios o significativos, los valores predeterminados efectivos son `minimumFractionDigits: 0`, `maximumFractionDigits: 0`, `minimumSignificantDigits: 1` y `maximumSignificantDigits: 2`. En ese caso, `roundingPriority` tiene como valor predeterminado `'morePrecision'` y `useGrouping`, `'min2'`. Establecer `style: 'unit'` también requiere una `unit` válida.

## Returns [#returns]

**Type** `string`

El valor formateado como una cadena monetaria localizada.

## Ejemplos [#examples]

```typescript
import { formatCurrency } from 'generaltranslation';

// Dólares estadounidenses
console.log(formatCurrency(1234.56, 'USD', { locales: 'en-US' }));
// Output: "$1,234.56"

// Euros, configuración regional alemana
console.log(formatCurrency(1234.56, 'EUR', { locales: 'de-DE' }));
// Output: "1.234,56 €"

// Yenes japoneses (sin decimales)
console.log(formatCurrency(1234, 'JPY', { locales: 'ja-JP' }));
// Output: "￥1,234"
```

## Notas [#notes]

* Pasa siempre un valor explícito de `locales` para obtener un resultado correcto y determinista.
* Pasa cualquier `Intl.NumberFormatOptions` (por ejemplo, `minimumFractionDigits`) junto con `locales` para ajustar con mayor precisión el resultado.

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.
