Documentación: Función getEnumerationContent en intlayer

Descripción:

La función getEnumerationContent recupera contenido correspondiente a una cantidad específica basada en condiciones predefinidas en un objeto de enumeración. Las condiciones se definen como claves, y su prioridad se determina por su orden en el objeto.

Parámetros:

enumerationContent: QuantityContent<Content>
- Descripción: Un objeto donde las claves representan condiciones (por ejemplo, <=, <, >=, =) y los valores representan el contenido correspondiente. El orden de las claves define su prioridad de coincidencia.
- Tipo: QuantityContent<Content>
  - Content puede ser de cualquier tipo.
quantity: number
- Descripción: El valor numérico utilizado para coincidir con las condiciones en enumerationContent.
- Tipo: number

Devuelve:

Tipo: Content
Descripción: El contenido correspondiente a la primera condición coincidente en enumerationContent. Si no se encuentra coincidencia, se configura para manejarse de acuerdo con la implementación (por ejemplo, error o contenido de reserva).

Ejemplo de Uso:

Uso Básico:

typescript

1import { getEnumerationContent } from "@intlayer/config/client";
2
3const content = getEnumerationContent(
4  {
5    "<=-2.3": "Tienes menos de -2.3",
6    "<1": "Tienes menos de uno",
7    "2": "Tienes dos",
8    ">=3": "Tienes tres o más",
9  },
10  2
11);
12
13console.log(content); // Salida: "Tienes dos"

Prioridad de Condiciones:

typescript

1const content = getEnumerationContent(
2  {
3    "<4": "Tienes menos de cuatro",
4    "2": "Tienes dos",
5  },
6  2
7);
8
9console.log(content); // Salida: "Tienes menos de cuatro"

Casos Límites:

Sin Condición Coincidente:
- Si ninguna condición coincide con la cantidad proporcionada, la función retornará undefined o manejará explícitamente el escenario por defecto/de reserva.
Condiciones Ambiguas:
- Si las condiciones se superponen, la primera condición coincidente (basada en el orden del objeto) tiene prioridad.
Claves Inválidas:
- La función asume que todas las claves en enumerationContent son válidas y pueden ser analizadas como condiciones. Claves inválidas o mal formateadas pueden llevar a un comportamiento inesperado.
Cumplimiento de TypeScript:
- La función asegura que el tipo Content sea consistente en todas las claves, permitiendo la seguridad de tipos en el contenido recuperado.

Notas:

La utilidad findMatchingCondition se utiliza para determinar la condición apropiada basada en la cantidad dada.

Si tienes una idea para mejorar esta documentación, no dudes en contribuir enviando una pull request en GitHub.

Enlace de GitHub a la documentación

getTranslationContent getHTMLTextDir