---
createdAt: 2024-08-13
updatedAt: 2025-08-20
title: Formateadores
description: Utilidades de formateo conscientes del locale basadas en Intl para números, porcentajes, moneda, fechas, tiempo relativo, unidades y notación compacta. Incluye un helper Intl en caché.
keywords:
- Formateadores
- Intl
- Número
- Moneda
- Porcentaje
- Fecha
- Tiempo Relativo
- Unidades
- Compacto
- Lista
- Internacionalización
slugs:
- doc
- formatters
history:
- version: 5.8.0
date: 2025-08-20
changes: Añadidos formateadores para Vue
- version: 5.8.0
date: 2025-08-18
changes: Añadida documentación de formateadores
- version: 5.8.0
date: 2025-08-20
changes: Añadido formateadores de vue
- version: 5.8.0
date: 2025-08-18
changes: Añadida documentación de formateadores
- version: 5.8.0
date: 2025-08-20
changes: Añadida documentación del formateador de listas
- version: 5.8.0
date: 2025-08-20
changes: Añadidas utilidades Intl adicionales (DisplayNames, Collator, PluralRules)
- version: 5.8.0
date: 2025-08-20
changes: Añadidas utilidades de configuración regional (getLocaleName, getLocaleLang, getLocaleFromPath, etc.)
- version: 5.8.0
date: 2025-08-20
changes: Añadidas utilidades para manejo de contenido (getContent, getTranslation, getIntlayer, etc.)
---
# Formateadores de Intlayer
## Resumen
Intlayer proporciona un conjunto de helpers ligeros construidos sobre las APIs nativas de `Intl`, además de un wrapper `Intl` en caché para evitar construir repetidamente formateadores pesados. Estas utilidades son completamente conscientes del locale y pueden usarse desde el paquete principal `intlayer`.
### Importar
```ts
import {
Intl,
number,
percentage,
currency,
date,
relativeTime,
units,
compact,
list,
getLocaleName,
getLocaleLang,
getLocaleFromPath,
getPathWithoutLocale,
getLocalizedUrl,
getHTMLTextDir,
getContent,
getTranslation,
getIntlayer,
getIntlayerAsync,
} from "intlayer";
```
Si usas React, también hay hooks disponibles; consulta `react-intlayer/format`.
## Intl en caché
El `Intl` exportado es un wrapper ligero y en caché alrededor del `Intl` global. Memoiza instancias de `NumberFormat`, `DateTimeFormat`, `RelativeTimeFormat`, `ListFormat`, `DisplayNames`, `Collator` y `PluralRules`, lo que evita reconstruir repetidamente el mismo formateador.
Debido a que la construcción de formateadores es relativamente costosa, esta caché mejora el rendimiento sin cambiar el comportamiento. El wrapper expone la misma API que el `Intl` nativo, por lo que el uso es idéntico.
- La caché es por proceso y transparente para los llamadores.
> Si `Intl.DisplayNames` no está disponible en el entorno, se imprime una única advertencia solo para desarrolladores (considera usar un polyfill).
Ejemplos:
```ts
import { Intl } from "intlayer";
// Formateo de números
const numberFormat = new Intl.NumberFormat("en-GB", {
style: "currency",
currency: "GBP",
});
numberFormat.format(1234.5); // "£1,234.50"
// Nombres para idiomas, regiones, etc.
const displayNames = new Intl.DisplayNames("fr", { type: "language" });
displayNames.of("en"); // "anglais"
// Ordenación para clasificación
const collator = new Intl.Collator("fr", { sensitivity: "base" });
collator.compare("é", "e"); // 0 (igual)
// Reglas de pluralización
const pluralRules = new Intl.PluralRules("fr");
pluralRules.select(1); // "one"
pluralRules.select(2); // "other"
```
## Utilidades adicionales de Intl
Más allá de los ayudantes para formateadores, también puedes usar directamente el wrapper cacheado de Intl para otras funcionalidades de Intl:
### `Intl.DisplayNames`
Para nombres localizados de idiomas, regiones, monedas y escrituras:
```ts
import { Intl } from "intlayer";
const languageNames = new Intl.DisplayNames("en", { type: "language" });
languageNames.of("fr"); // "Francés"
const regionNames = new Intl.DisplayNames("fr", { type: "region" });
regionNames.of("US"); // "Estados Unidos"
```
### `Intl.Collator`
Para la comparación y ordenación de cadenas conscientes del locale:
```ts
import { Intl } from "intlayer";
const collator = new Intl.Collator("de", {
sensitivity: "base",
numeric: true,
});
const words = ["äpfel", "zebra", "100", "20"];
words.sort(collator.compare); // ["20", "100", "äpfel", "zebra"]
```
### `Intl.PluralRules`
Para determinar las formas plurales en diferentes locales:
```ts
import { Intl } from "intlayer";
const pluralRules = new Intl.PluralRules("ar");
pluralRules.select(0); // "zero"
pluralRules.select(1); // "one"
pluralRules.select(2); // "two"
pluralRules.select(3); // "few"
pluralRules.select(11); // "many"
```
## Utilidades de Locale
### `getLocaleName(displayLocale, targetLocale?)`
Obtiene el nombre localizado de un locale en otro locale:
```ts
import { getLocaleName } from "intlayer";
getLocaleName("fr", "en"); // "French"
getLocaleName("en", "fr"); // "anglais"
getLocaleName("de", "es"); // "alemán"
```
- **displayLocale**: El locale para el cual obtener el nombre
- **targetLocale**: El locale en el que se mostrará el nombre (por defecto es displayLocale)
### `getLocaleLang(locale?)`
Extrae el código de idioma de una cadena de locale:
```ts
import { getLocaleLang } from "intlayer";
getLocaleLang("en-US"); // "en"
getLocaleLang("fr-CA"); // "fr"
getLocaleLang("de"); // "de"
```
- **locale**: El locale del cual extraer el idioma (por defecto es el locale actual)
### `getLocaleFromPath(inputUrl)`
Extrae el segmento de locale de una URL o ruta:
```ts
import { getLocaleFromPath } from "intlayer";
getLocaleFromPath("/en/dashboard"); // "en"
getLocaleFromPath("/fr/dashboard"); // "fr"
getLocaleFromPath("/dashboard"); // "en" (locale predeterminado)
getLocaleFromPath("https://example.com/es/about"); // "es"
```
- **inputUrl**: La cadena completa de URL o ruta a procesar
- **returns**: El locale detectado o el locale predeterminado si no se encuentra ningún locale
### `getPathWithoutLocale(inputUrl, locales?)`
Elimina el segmento de locale de una URL o ruta:
```ts
import { getPathWithoutLocale } from "intlayer";
getPathWithoutLocale("/en/dashboard"); // "/dashboard"
getPathWithoutLocale("/fr/dashboard"); // "/dashboard"
getPathWithoutLocale("https://example.com/en/about"); // "https://example.com/about"
```
- **inputUrl**: La cadena completa de URL o ruta a procesar
- **locales**: Matriz opcional de locales soportados (por defecto, los locales configurados)
- **returns**: La URL sin el segmento de locale
### `getLocalizedUrl(url, currentLocale, locales?, defaultLocale?, prefixDefault?)`
Genera una URL localizada para el locale actual:
```ts
import { getLocalizedUrl } from "intlayer";
getLocalizedUrl("/about", "fr", ["en", "fr"], "en", false); // "/fr/about"
getLocalizedUrl("/about", "en", ["en", "fr"], "en", false); // "/about"
getLocalizedUrl("https://example.com/about", "fr", ["en", "fr"], "en", true); // "https://example.com/fr/about"
```
- **url**: La URL original para localizar
- **currentLocale**: El locale actual
- **locales**: Matriz opcional de locales soportados (por defecto, los locales configurados)
- **defaultLocale**: Locale predeterminado opcional (por defecto, el locale predeterminado configurado)
- **prefixDefault**: Indica si se debe prefijar el locale predeterminado (por defecto, el valor configurado)
### `getHTMLTextDir(locale?)`
Devuelve la dirección del texto para un locale:
```ts
import { getHTMLTextDir } from "intlayer";
getHTMLTextDir("en-US"); // "ltr"
getHTMLTextDir("ar"); // "rtl"
getHTMLTextDir("he"); // "rtl"
```
- **locale**: El locale para obtener la dirección del texto (por defecto, el locale actual)
- **returns**: `"ltr"`, `"rtl"` o `"auto"`
## Utilidades para el Manejo de Contenido
### `getContent(node, nodeProps, locale?)`
Transforma un nodo de contenido con todos los plugins disponibles (traducción, enumeración, inserción, etc.):
```ts
import { getContent } from "intlayer";
const content = getContent(
contentNode,
{ dictionaryKey: "common", dictionaryPath: "/path/to/dict" },
"fr"
);
```
- **node**: El nodo de contenido a transformar
- **nodeProps**: Propiedades para el contexto de transformación
- **locale**: Locale opcional (por defecto, el locale predeterminado configurado)
### `getTranslation(languageContent, locale?, fallback?)`
Extrae contenido para un locale específico de un objeto de contenido multilingüe:
```ts
import { getTranslation } from "intlayer";
const content = getTranslation(
{
en: "Hello",
fr: "Bonjour",
de: "Hallo",
},
"fr",
true
); // "Bonjour"
```
- **languageContent**: Objeto que mapea locales a contenido
- **locale**: Locale objetivo (por defecto el locale predeterminado configurado)
- **fallback**: Indica si se debe usar el locale predeterminado como respaldo (por defecto es true)
### `getIntlayer(dictionaryKey, locale?, plugins?)`
Recupera y transforma contenido de un diccionario por clave:
```ts
import { getIntlayer } from "intlayer";
const content = getIntlayer("common", "fr");
const nestedContent = getIntlayer("common", "fr", customPlugins);
```
- **dictionaryKey**: La clave del diccionario a recuperar
- **locale**: Locale opcional (por defecto es el locale predeterminado configurado)
- **plugins**: Array opcional de plugins personalizados para transformación
### `getIntlayerAsync(dictionaryKey, locale?, plugins?)`
Recupera contenido de un diccionario remoto de forma asíncrona:
```ts
import { getIntlayerAsync } from "intlayer";
const content = await getIntlayerAsync("common", "fr");
```
- **dictionaryKey**: La clave del diccionario a recuperar
- **locale**: Locale opcional (por defecto es el locale predeterminado configurado)
- **plugins**: Array opcional de plugins personalizados para transformación
## Formateadores
Todos los helpers a continuación son exportados desde `intlayer`.
### `number(value, options?)`
Formatea un valor numérico utilizando agrupación y decimales sensibles al locale.
- **value**: `number | string`
- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
Ejemplos:
```ts
import { number } from "intlayer";
number(123456.789); // "123,456.789" (en en-US)
number("1000000", { locale: "fr" }); // "1 000 000"
number(1234.5, { minimumFractionDigits: 2 }); // "1,234.50"
```
### `percentage(value, options?)`
Formatea un número como una cadena de porcentaje.
Comportamiento: los valores mayores que 1 se interpretan como porcentajes enteros y se normalizan (por ejemplo, `25` → `25%`, `0.25` → `25%`).
- **value**: `number | string`
- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
Ejemplos:
```ts
import { percentage } from "intlayer";
percentage(0.25); // "25%"
percentage(25); // "25%"
percentage(0.237, { minimumFractionDigits: 1 }); // "23.7%"
```
### `currency(value, options?)`
Formatea un valor como moneda localizada. Por defecto es `USD` con dos dígitos decimales.
- **value**: `number | string`
- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
- Campos comunes: `currency` (por ejemplo, `"EUR"`), `currencyDisplay` (`"symbol" | "code" | "name"`)
Ejemplos:
```ts
import { currency } from "intlayer";
currency(1234.5, { currency: "EUR" }); // "€1,234.50"
currency("5000", { locale: "fr", currency: "CAD", currencyDisplay: "code" }); // "5 000,00 CAD"
```
### `date(date, optionsOrPreset?)`
Formatea un valor de fecha/hora con `Intl.DateTimeFormat`.
- **date**: `Date | string | number`
- **optionsOrPreset**: `Intl.DateTimeFormatOptions & { locale?: LocalesValues }` o uno de los preajustes:
- Preajustes: `"short" | "long" | "dateOnly" | "timeOnly" | "full"`
Ejemplos:
```ts
import { date } from "intlayer";
date(new Date(), "short"); // p. ej., "08/02/25, 14:30"
date("2025-08-02T14:30:00Z", { locale: "fr", month: "long", day: "numeric" }); // "2 août"
```
### `relativeTime(from, to = new Date(), options?)`
Formatea el tiempo relativo entre dos instantes con `Intl.RelativeTimeFormat`.
- Pasa "now" como primer argumento y el objetivo como segundo para obtener una frase natural.
- **from**: `Date | string | number`
- **to**: `Date | string | number` (por defecto `new Date()`)
- **options**: `{ locale?: LocalesValues; unit?: Intl.RelativeTimeFormatUnit; numeric?: Intl.RelativeTimeFormatNumeric; style?: Intl.RelativeTimeFormatStyle }`
- El valor predeterminado de `unit` es `"second"`.
Ejemplos:
```ts
import { relativeTime } from "intlayer";
const now = new Date();
const in3Days = new Date(now.getTime() + 3 * 864e5);
relativeTime(now, in3Days, { unit: "day" }); // "en 3 días"
const twoHoursAgo = new Date(now.getTime() - 2 * 3600e3);
relativeTime(now, twoHoursAgo, { unit: "hour", numeric: "auto" }); // "hace 2 horas"
```
### `units(value, options?)`
Formatea un valor numérico como una cadena de unidad localizada usando `Intl.NumberFormat` con `style: 'unit'`.
- **value**: `number | string`
- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }`
- Campos comunes: `unit` (por ejemplo, `"kilometer"`, `"byte"`), `unitDisplay` (`"short" | "narrow" | "long"`)
- Valores predeterminados: `unit: 'day'`, `unitDisplay: 'short'`, `useGrouping: false`
Ejemplos:
```ts
import { units } from "intlayer";
units(5, { unit: "kilometer", unitDisplay: "long", locale: "en-GB" }); // "5 kilometers"
units(1024, { unit: "byte", unitDisplay: "narrow" }); // "1,024B" (dependiente del locale)
```
### `compact(value, options?)`
Formatea un número usando notación compacta (por ejemplo, `1.2K`, `1M`).
- **value**: `number | string`
- **options**: `Intl.NumberFormatOptions & { locale?: LocalesValues }` (usa internamente `notation: 'compact'`)
Ejemplos:
```ts
import { compact } from "intlayer";
compact(1200); // "1.2K"
compact("1000000", { locale: "fr", compactDisplay: "long" }); // "1 million"
```
### `list(values, options?)`
Formatea un arreglo de valores en una cadena de lista localizada usando `Intl.ListFormat`.
- **values**: `(string | number)[]`
- **options**: `Intl.ListFormatOptions & { locale?: LocalesValues }`
- Campos comunes: `type` (`"conjunction" | "disjunction" | "unit"`), `style` (`"long" | "short" | "narrow"`)
- Valores por defecto: `type: 'conjunction'`, `style: 'long'`
Ejemplos:
```ts
import { list } from "intlayer";
list(["apple", "banana", "orange"]); // "apple, banana, and orange"
list(["red", "green", "blue"], { locale: "fr", type: "disjunction" }); // "rouge, vert ou bleu"
list([1, 2, 3], { type: "unit" }); // "1, 2, 3"
```
## Notas
- Todos los ayudantes aceptan entradas de tipo `string`; internamente se convierten a números o fechas.
- El locale por defecto es el configurado en `internationalization.defaultLocale` si no se proporciona.
- Estas utilidades son envoltorios ligeros; para un formateo avanzado, pase las opciones estándar de `Intl`.
## Puntos de entrada y re-exportaciones (`@index.ts`)
Los formateadores residen en el paquete core y se re-exportan desde paquetes de nivel superior para mantener las importaciones ergonómicas en diferentes entornos de ejecución:
Ejemplos:
```ts
// Código de la aplicación (recomendado)
import {
number,
currency,
date,
relativeTime,
units,
compact,
list,
Intl,
getLocaleName,
getLocaleLang,
getLocaleFromPath,
getPathWithoutLocale,
getLocalizedUrl,
getHTMLTextDir,
getContent,
getTranslation,
getIntlayer,
getIntlayerAsync,
} from "intlayer";
```
### React
Componentes cliente:
```tsx
import {
useNumber,
useCurrency,
useDate,
usePercentage,
useCompact,
useList,
useRelativeTime,
useUnit,
} from "react-intlayer/format";
// o en aplicaciones Next.js
import {
useNumber,
useCurrency,
useDate,
usePercentage,
useCompact,
useList,
useRelativeTime,
useUnit,
} from "next-intlayer/client/format";
const MyComponent = () => {
const number = useNumber();
const currency = useCurrency();
const date = useDate();
const percentage = usePercentage();
const compact = useCompact();
const list = useList();
const relativeTime = useRelativeTime();
const unit = useUnit();
return (
<div>
<p>{number(123456.789)}</p>
<p>{currency(1234.5, { currency: "EUR" })}</p>
<p>{date(new Date(), "short")}</p>
<p>{percentage(0.25)}</p>
<p>{compact(1200)}</p>
<p>{list(["apple", "banana", "orange"])}</p>
<p>{relativeTime(new Date(), new Date() + 1000)}</p>
<p>{unit(123456.789, { unit: "kilometer" })}</p>
</div>
);
};
```
Componentes del servidor (o tiempo de ejecución del servidor React):
```ts
import {
useNumber,
useCurrency,
useDate,
usePercentage,
useCompact,
useList,
useRelativeTime,
useUnit,
} from "react-intlayer/server/format";
// o en aplicaciones Next.js
import {
useNumber,
useCurrency,
useDate,
usePercentage,
useCompact,
useList,
useRelativeTime,
useUnit,
} from "next-intlayer/server/format";
```
> Estos hooks considerarán la configuración regional desde el `IntlayerProvider` o `IntlayerServerProvider`
### Vue
Componentes cliente:
```ts
import {
useNumber,
useCurrency,
useDate,
usePercentage,
useCompact,
useList,
useRelativeTime,
useUnit,
} from "vue-intlayer/format";
```
> Esos composables considerarán la configuración regional del `IntlayerProvider` inyectado.
