@intlayer/docs 5.5.10 → 5.5.11

package/docs/es/packages/intlayer/getLocalizedUrl.md

@@ -0,0 +1,247 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-06-29
+title: Documentación de la función getLocalizedUrl | intlayer
+description: Vea cómo usar la función getLocalizedUrl para el paquete intlayer
+keywords:
+  - getLocalizedUrl
+  - traducción
+  - Intlayer
+  - intlayer
+  - Internacionalización
+  - Documentación
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getLocalizedUrl
+---
+
+# Documentación: Función `getLocalizedUrl` en `intlayer`
+
+## Descripción
+
+La función `getLocalizedUrl` genera una URL localizada anteponiendo la URL dada con el locale especificado. Maneja tanto URLs absolutas como relativas, asegurando que se aplique el prefijo de locale correcto según la configuración.
+
+---
+
+## Parámetros
+
+- `url: string`
+
+  - **Descripción**: La cadena de URL original a la que se le antepondrá un locale.
+  - **Tipo**: `string`
+
+- `currentLocale: Locales`
+
+  - **Descripción**: El locale actual para el cual se está localizando la URL.
+  - **Tipo**: `Locales`
+
+- `locales: Locales[]`
+
+  - **Descripción**: Array opcional de locales soportados. Por defecto, se proporcionan los locales configurados en el proyecto.
+  - **Tipo**: `Locales[]`
+  - **Por defecto**: [`Configuración del Proyecto`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/configuration.md#middleware)
+
+- `defaultLocale: Locales`
+
+  - **Descripción**: El locale por defecto para la aplicación. Por defecto, se proporciona el locale por defecto configurado en el proyecto.
+  - **Tipo**: `Locales`
+  - **Por defecto**: [`Configuración del Proyecto`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/configuration.md#middleware)
+
+- `prefixDefault: boolean`
+  - **Descripción**: Indica si se debe anteponer el prefijo para el locale por defecto. Por defecto, se proporciona el valor configurado en el proyecto.
+  - **Tipo**: `boolean`
+  - **Por defecto**: [`Configuración del Proyecto`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/configuration.md#middleware)
+
+### Retorna
+
+- **Tipo**: `string`
+- **Descripción**: La URL localizada para el locale especificado.
+
+---
+
+## Ejemplo de Uso
+
+### URLs Relativas
+
+```typescript codeFormat="typescript"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+getLocalizedUrl(
+  "/about",
+  Locales.FRENCH,
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+
+// Salida: "/fr/about" para el locale francés
+// Salida: "/about" para el locale por defecto (inglés)
+```
+
+```javascript codeFormat="esm"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+getLocalizedUrl(
+  "/about",
+  Locales.FRENCH,
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+
+// Salida: "/fr/about" para el locale francés
+// Salida: "/about" para el locale por defecto (inglés)
+```
+
+```javascript codeFormat="esm"
+import { getLocalizedUrl, Locales } from "intlayer";
+
+getLocalizedUrl(
+  "/about",
+  Locales.FRENCH,
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+
+// Salida: "/fr/about" para el locale francés
+// Salida: "/about" para el locale por defecto (inglés)
+```
+
+```javascript codeFormat="commonjs"
+const { getLocalizedUrl, Locales } = require("intlayer");
+
+getLocalizedUrl(
+  "/about",
+  Locales.FRENCH,
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+
+// Salida: "/fr/about" para el locale francés
+// Salida: "/about" para el locale por defecto (inglés)
+```
+
+### URLs Absolutas
+
+```typescript
+getLocalizedUrl(
+  "https://example.com/about",
+  Locales.FRENCH, // Locale Actual
+  [Locales.ENGLISH, Locales.FRENCH], // Locales Soportados
+  Locales.ENGLISH, // Locale por Defecto
+  false // Prefijar el Locale por Defecto
+); // Salida: "https://example.com/fr/about" para el francés
+
+getLocalizedUrl(
+  "https://example.com/about",
+  Locales.ENGLISH, // Locale Actual
+  [Locales.ENGLISH, Locales.FRENCH], // Locales Soportados
+  Locales.ENGLISH, // Locale por Defecto
+  false // Prefijar el Locale por Defecto
+); // Salida: "https://example.com/about" para el inglés
+
+getLocalizedUrl(
+  "https://example.com/about",
+  Locales.ENGLISH, // Locale Actual
+  [Locales.ENGLISH, Locales.FRENCH], // Locales Soportados
+  Locales.ENGLISH, // Locale por Defecto
+  true // Prefijar el Locale por Defecto
+); // Salida: "https://example.com/en/about" para el inglés
+```
+
+### Locale No Soportado
+
+```typescript
+getLocalizedUrl(
+  "/about",
+  Locales.ITALIAN, // Locale Actual
+  [Locales.ENGLISH, Locales.FRENCH], // Locales Soportados
+  Locales.ENGLISH // Locale por Defecto
+); // Salida: "/about" (no se aplica prefijo para locales no soportados)
+```
+
+---
+
+## Casos Especiales
+
+- **Sin Segmento de Locale:**
+
+  - Si la URL no contiene ningún segmento de locale, la función añade de forma segura el locale apropiado como prefijo.
+
+- **Locale por Defecto:**
+
+  - Cuando `prefixDefault` es `false`, la función no añade prefijo a la URL para el locale por defecto.
+
+- **Locales No Soportados:**
+  - Para locales que no están listados en `locales`, la función no aplica ningún prefijo.
+
+---
+
+## Uso en Aplicaciones
+
+En una aplicación multilingüe, configurar los ajustes de internacionalización con `locales` y `defaultLocale` es fundamental para asegurar que se muestre el idioma correcto. A continuación, se muestra un ejemplo de cómo `getLocalizedUrl` puede usarse en la configuración de una aplicación:
+
+```tsx codeFormat="typescript"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+// Configuración para locales soportados y locale por defecto
+export default {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+} satisfies IntlayerConfig;
+
+export default config;
+```
+
+```javascript codeFormat="esm"
+import { Locales } from "intlayer";
+
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+export default config;
+```
+
+```javascript codeFormat="commonjs"
+const { Locales } = require("intlayer");
+
+/** @type {import('intlayer').IntlayerConfig} */
+const config = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+module.exports = config;
+```
+
+La configuración anterior asegura que la aplicación reconozca `ENGLISH`, `FRENCH` y `SPANISH` como idiomas soportados y utilice `ENGLISH` como idioma predeterminado.
+
+Usando esta configuración, la función `getLocalizedUrl` puede generar dinámicamente URLs localizadas basadas en la preferencia de idioma del usuario:
+
+```typescript
+getLocalizedUrl("/about", Locales.FRENCH); // Salida: "/fr/about"
+getLocalizedUrl("/about", Locales.SPANISH); // Salida: "/es/about"
+getLocalizedUrl("/about", Locales.ENGLISH); // Salida: "/about"
+```
+
+Al integrar `getLocalizedUrl`, los desarrolladores pueden mantener estructuras de URL consistentes en múltiples idiomas, mejorando tanto la experiencia del usuario como el SEO.
+
+## Historial del Documento
+
+- 5.5.10 - 2025-06-29: Historial inicial

package/docs/es/packages/intlayer/getMultilingualUrls.md

@@ -0,0 +1,226 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-06-29
+title: Documentación de la función getMultilingualUrls | intlayer
+description: Vea cómo usar la función getMultilingualUrls para el paquete intlayer
+keywords:
+  - getMultilingualUrls
+  - traducción
+  - Intlayer
+  - intlayer
+  - Internacionalización
+  - Documentación
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getMultilingualUrls
+---
+
+# Documentación: Función `getMultilingualUrls` en `intlayer`
+
+## Descripción
+
+La función `getMultilingualUrls` genera un mapeo de URLs multilingües anteponiendo la URL dada con cada localización soportada. Puede manejar tanto URLs absolutas como relativas, aplicando el prefijo de localización apropiado basado en la configuración proporcionada o los valores predeterminados.
+
+---
+
+## Parámetros
+
+- `url: string`
+
+  - **Descripción**: La cadena URL original a la que se le antepondrán los prefijos de localización.
+  - **Tipo**: `string`
+
+- `locales: Locales[]`
+
+  - **Descripción**: Arreglo opcional de locales soportados. Por defecto, usa los locales configurados en el proyecto.
+  - **Tipo**: `Locales[]`
+  - **Por defecto**: `localesDefault`
+
+- `defaultLocale: Locales`
+
+  - **Descripción**: El local predeterminado para la aplicación. Por defecto, usa el local predeterminado configurado en el proyecto.
+  - **Tipo**: `Locales`
+  - **Por defecto**: `defaultLocaleDefault`
+
+- `prefixDefault: boolean`
+  - **Descripción**: Indica si se debe anteponer el prefijo para el local predeterminado. Por defecto, usa el valor configurado en el proyecto.
+  - **Tipo**: `boolean`
+  - **Por defecto**: `prefixDefaultDefault`
+
+### Retorna
+
+- **Tipo**: `IConfigLocales<string>`
+- **Descripción**: Un objeto que mapea cada localización a su URL multilingüe correspondiente.
+
+---
+
+## Ejemplo de Uso
+
+### URLs Relativas
+
+```typescript codeFormat="typescript"
+import { getMultilingualUrls, Locales } from "intlayer";
+
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+// Salida: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+```javascript codeFormat="esm"
+import { getMultilingualUrls, Locales } from "intlayer";
+
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+// Salida: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+```javascript codeFormat="commonjs"
+const { getMultilingualUrls, Locales } = require("intlayer");
+
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  false
+);
+// Salida: {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard"
+// }
+```
+
+### URLs Absolutas
+
+```typescript
+getMultilingualUrls(
+  "https://example.com/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH],
+  Locales.ENGLISH,
+  true
+);
+// Salida: {
+//   en: "https://example.com/en/dashboard",
+//   fr: "https://example.com/fr/dashboard"
+// }
+```
+
+---
+
+## Casos Especiales
+
+- **Sin Segmento de Localización:**
+
+  - La función elimina cualquier segmento de idioma existente en la URL antes de generar las asignaciones multilingües.
+
+- **Idioma Predeterminado:**
+
+  - Cuando `prefixDefault` es `false`, la función no antepone el prefijo a la URL para el idioma predeterminado.
+
+- **Idiomas No Soportados:**
+  - Solo se consideran los idiomas proporcionados en el arreglo `locales` para generar las URLs.
+
+---
+
+## Uso en Aplicaciones
+
+En una aplicación multilingüe, configurar los ajustes de internacionalización con `locales` y `defaultLocale` es fundamental para asegurar que se muestre el idioma correcto. A continuación, se muestra un ejemplo de cómo se puede usar `getMultilingualUrls` en la configuración de una aplicación:
+
+```tsx codeFormat="typescript"
+import { Locales, type IntlayerConfig } from "intlayer";
+
+// Configuración para los idiomas soportados y el idioma predeterminado
+export default {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+} satisfies IntlayerConfig;
+
+export default config;
+```
+
+```javascript codeFormat="esm"
+import { Locales } from "intlayer";
+
+/** @type {import('intlayer').IntlayerConfig} */
+// Configuración para los idiomas soportados y el idioma predeterminado
+const config = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+export default config;
+```
+
+```javascript codeFormat="commonjs"
+const { Locales } = require("intlayer");
+
+/** @type {import('intlayer').IntlayerConfig} */
+// Configuración para los idiomas soportados y el idioma predeterminado
+const config = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+};
+
+module.exports = config;
+```
+
+La configuración anterior asegura que la aplicación reconozca `ENGLISH`, `FRENCH` y `SPANISH` como idiomas soportados y utilice `ENGLISH` como idioma de reserva.
+
+Usando esta configuración, la función `getMultilingualUrls` puede generar dinámicamente mapeos de URLs multilingües basados en los locales soportados por la aplicación:
+
+```typescript
+getMultilingualUrls(
+  "/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  Locales.ENGLISH
+);
+// Salida:
+// {
+//   en: "/dashboard",
+//   fr: "/fr/dashboard",
+//   es: "/es/dashboard"
+// }
+
+getMultilingualUrls(
+  "https://example.com/dashboard",
+  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+  Locales.ENGLISH,
+  true
+);
+// Salida:
+// {
+//   en: "https://example.com/en/dashboard",
+//   fr: "https://example.com/fr/dashboard",
+//   es: "https://example.com/es/dashboard"
+// }
+```
+
+Al integrar `getMultilingualUrls`, los desarrolladores pueden mantener estructuras de URL consistentes a través de múltiples idiomas, mejorando tanto la experiencia del usuario como el SEO.
+
+## Historial del Documento
+
+- 5.5.10 - 2025-06-29: Historial inicial

package/docs/es/packages/intlayer/getPathWithoutLocale.md

@@ -0,0 +1,76 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-06-29
+title: Documentación de la función getPathWithoutLocale | intlayer
+description: Vea cómo usar la función getPathWithoutLocale para el paquete intlayer
+keywords:
+  - getPathWithoutLocale
+  - traducción
+  - Intlayer
+  - intlayer
+  - Internacionalización
+  - Documentación
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getPathWithoutLocale
+---
+
+# Documentación: Funciones `getPathWithoutLocale` en `intlayer`
+
+## Descripción
+
+Elimina el segmento de localización del URL o ruta proporcionada si está presente. Funciona tanto con URLs absolutas como con rutas relativas.
+
+## Parámetros
+
+- `inputUrl: string`
+
+  - **Descripción**: La cadena completa de URL o ruta a procesar.
+  - **Tipo**: `string`
+
+- `locales: Locales[]`
+  - **Descripción**: Array opcional de locales soportados. Por defecto, los locales configurados en el proyecto.
+  - **Tipo**: `Locales[]`
+
+## Retorna
+
+- **Tipo**: `string`
+- **Descripción**: La cadena de URL o ruta sin el segmento de localización.
+
+## Ejemplo de uso
+
+```typescript codeFormat="typescript"
+import { getPathWithoutLocale } from "intlayer";
+
+console.log(getPathWithoutLocale("/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("/en/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // Salida: "https://example.com/dashboard"
+```
+
+```javascript codeFormat="esm"
+import { getPathWithoutLocale } from "intlayer";
+
+console.log(getPathWithoutLocale("/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("/en/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // Salida: "https://example.com/dashboard"
+```
+
+```javascript codeFormat="commonjs"
+const { getPathWithoutLocale } = require("intlayer");
+
+console.log(getPathWithoutLocale("/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("/en/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("/fr/dashboard")); // Salida: "/dashboard"
+console.log(getPathWithoutLocale("https://example.com/en/dashboard")); // Salida: "https://example.com/dashboard"
+```
+
+## Historial de Documentación
+
+- 5.5.10 - 2025-06-29: Historial inicial