# generaltranslation: General Translation Core SDK: formatMessage
URL: https://generaltranslation.com/es/docs/core/class/methods/formatting/format-message.mdx
---
title: formatMessage
description: Referencia de la API para el método formatMessage de GT
---

## Descripción general

El método `formatMessage` formatea mensajes con sustitución de variables y formato según la configuración regional.
Basado en la biblioteca [`intl-messageformat`](https://formatjs.github.io/docs/intl-messageformat/) de Format.JS, admite patrones de formato de mensaje ICU.

Este método es esencial para la interpolación de variables y la pluralización.
También admite el formateo de números y fechas, entre otras funciones.

```typescript
const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'fr'
});

const formatted = gt.formatMessage('Hello {name}, you have {count} messages', {
  variables: { name: 'Alice', count: 5 }
});
// Devuelve: "Hello Alice, you have 5 messages"
```

***


## Referencia

### Parámetros

<TypeTable
  type={{
  "message": {
    type: 'string',
    optional: false,
  },
  "options?": {
    type: 'object',
    optional: true,
  }
}}
/>

### Objeto de opciones

| Propiedad    | Tipo                 | Opcional | Descripción                                                                                                              |
| ------------ | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `locales`    | `string \| string[]` | ✓        | Configuración(es) regional(es) que se usarán para aplicar el formato (anula los valores predeterminados de la instancia) |
| `variables`  | `FormatVariables`    | ✓        | Objeto que contiene las variables para la interpolación de mensajes                                                      |
| `dataFormat` | `StringFormat`       | ✓        | Formato de datos de la cadena del mensaje (p. ej., `'ICU'`, `'I18NEXT'`, `'STRING'`)                                     |

### Tipo FormatVariables

```typescript
type FormatVariables = Record<string, string | number | boolean | null | undefined | Date>;
```

### Devuelve

`cadena` - El mensaje formateado, con las variables sustituidas y el formato específico de la configuración regional aplicado.

***

## Comportamiento

### Sustitución de variables

* Variables simples: `{variableName}` → se reemplazan por un valor de cadena
* Patrones de ICU: `{count, plural, ...}` → se procesan según las reglas de formato de ICU
* Variables faltantes: producirán un error
* Llaves dobles: escapan el comportamiento de las llaves y se muestran como una sola llave

### Compatibilidad con el formato de mensajes

* **Interpolación simple**: `{variable}`
* **Formateo de números**: `{price, number, ::currency/USD}`, `{discount, number, percent}`, `{num, number, integer}`
* **Formateo de fechas**: `{date, date, short}`, `{time, time, short}`
* **Pluralización**: `{count, plural, =0 {none} =1 {one} other {many}}`
* **Selección**: `{gender, select, male {he} female {she} other {they}}`
* **Selectordinal**: `{place, selectordinal, =1 {#st} =2 {#nd} =3 {#rd} other {#th}}`

***

## Ejemplos

### Sustitución básica de variables

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

const message = gt.formatMessage('Welcome {name}!', {
  variables: { name: 'John' }
});
console.log(message); // "Welcome John!"
```


### Pluralización con el formato ICU

```typescript
const message = gt.formatMessage(
  'You have {count, plural, =0 {no items} =1 {one item} other {# items}} in your cart',
  {
    variables: { count: 3 }
  }
);
console.log(message); // "You have 3 items in your cart" (Tienes 3 artículos en tu carrito)
```


### Formato de números y Currency

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

const message = gt.formatMessage(
  'Your total is {price, number, ::currency/USD} with {discount, number, percent} off',
  {
    variables: { 
      price: 99.99,
      discount: 0.15 
    }
  }
);
console.log(message); // "Tu total es $99.99 con 15% de descuento"
```


### Templates de mensajes complejos

```typescript
const orderStatusMessage = gt.formatMessage(`
  Order #{orderId} status update:
  - Items: {itemCount, plural, =0 {no items} =1 {one item} other {# items}}
  - Total: {total, number, ::currency/USD}
  - Status: {status, select, 
      pending {Pending} 
      shipped {Shipped} 
      delivered {Delivered} 
      other {Unknown}}
  - Delivery: {deliveryDate, date, short}
`, {
  variables: {
    orderId: 'ORD-12345',
    itemCount: 3,
    total: 149.97,
    status: 'shipped',
    deliveryDate: new Date('2024-03-20')
  }
});
```

***


## Notas

* El método procesa la sintaxis del formato de mensaje ICU para aplicar formato avanzado mediante [`Intl.MessageFormat`](https://formatjs.github.io/docs/intl-messageformat/) de Format.JS.
* Si faltan variables, se producirá un error.
* El formateo de números, el formateo de fechas y Currency específico de la configuración regional se aplica automáticamente.

## Próximos pasos

* Consulta la [documentación de `Intl.MessageFormat`](https://formatjs.github.io/docs/intl-messageformat/) para conocer más opciones
* Formatea números con [formatNum](/docs/core/class/methods/formatting/format-num)