# General Translation Platform: formatCurrency
URL: https://generaltranslation.com/es/docs/platform/core/reference/gt-class-methods/formatting/format-currency.mdx
---

title: formatCurrency
description: Formatea un valor monetario según la configuración regional en una instancia de GT. Referencia de API para formatCurrency.

---

Formatea un valor numérico como una cadena monetaria localizada en una instancia de [GT](/docs/platform/core/reference/gt-class/constructor). General Translation usa la API integrada `Intl.NumberFormat` con el estilo de moneda, por lo que los importes se muestran con el símbolo y el formato de agrupación y decimales adecuados para cada configuración regional.

## Resumen general [#overview]

Llama a `formatCurrency` en una instancia de [`GT`](/docs/platform/core/reference/gt-class/constructor) con un valor numérico, un código de divisa ISO 4217 y, opcionalmente, un objeto de opciones. Devuelve la cadena monetaria localizada formateada.

```typescript
const gt = new GT({ targetLocale: 'en-US' });

const price = gt.formatCurrency(1234.56, 'USD');
// "$1,234.56"
```

Firma:

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

*Nota: `formatCurrency` se ejecuta localmente con `Intl.NumberFormat` y no requiere una API key. De forma predeterminada, da formato según la configuración regional de destino de la instancia, y recurre primero a la configuración regional de origen y luego al valor predeterminado de la biblioteca (`en`); pasa `locales` para anularlo. Para dar formato sin una instancia de `GT`, consulta la versión independiente de [`formatCurrency`](/docs/platform/core/reference/utility-functions/formatting/format-currency).*

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

* **Estilo de Currency.** El formato se delega a [`Intl.NumberFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) con `style: 'currency'` y el código `currency` proporcionado.
* **Resolución de la configuración regional.** De forma predeterminada, el método aplica el formato según la configuración regional de destino de la instancia; si no está disponible, recurre primero a la configuración regional de origen y después al valor predeterminado de la biblioteca (`en`), no a la lista de configuración `locales`. Pasa `locales` en las opciones para anular este comportamiento.
* **Posición del símbolo.** El símbolo de Currency, los separadores de agrupación y el formato decimal siguen la configuración regional resuelta, no el país de la moneda.

## 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 que amplía `Intl.NumberFormatOptions` con una sobrescritura de `locales`. | `object` | Sí       | —              |

### `value` [#value]

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

El valor numérico que se debe formatear.

### `currency` [#currency]

**Tipo** `string` · **Obligatorio**

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

### `options` [#options]

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

Configuración de formato. Amplía `Intl.NumberFormatOptions` con un campo `locales` adicional:

| Nombre    | Descripción                                                                     | Tipo                 | Opcional | Predeterminado                                    |
| --------- | ------------------------------------------------------------------------------- | -------------------- | -------- | ------------------------------------------------- |
| `locales` | Reemplaza las configuraciones regionales usadas para el formato.                | `string \| string[]` | Sí       | configuración regional de destino de la instancia |
| `style`   | Estilo de formato de número; de forma predeterminada, usa el formato de moneda. | `string`             | Sí       | `'currency'`                                      |

## Returns [#returns]

**Type** `string`

El valor formateado como una cadena monetaria localizada.

## Ejemplos [#examples]

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

const gt = new GT({ targetLocale: 'en-US' });

// Configuración regional de destino de la instancia predeterminada
console.log(gt.formatCurrency(1234.56, 'USD'));
// Salida: "$1,234.56"

// Sobrescribir la configuración regional por llamada
console.log(gt.formatCurrency(1234.56, 'EUR', { locales: ['de-DE'] }));
// Salida: "1.234,56 €"

// Sin decimales
console.log(gt.formatCurrency(1234, 'JPY', { locales: ['ja-JP'] }));
// Salida: "￥1,234"
```

## Notas [#notes]

* El método usa internamente `Intl.NumberFormat` nativo del navegador, por lo que los importes siguen las convenciones de la configuración regional.
* Pasa cualquier `Intl.NumberFormatOptions` (por ejemplo, `minimumFractionDigits`) junto con `locales` para ajustar con mayor precisión el resultado.