Documentación: Función getEnumeration en intlayer

Descripción

La función getEnumeration 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

Retornos

• Tipo: Content
• Descripción: El contenido correspondiente a la primera condición coincidente en el enumerationContent. Si no se encuentra coincidencia, se maneja según la implementación (por ejemplo, error o contenido predeterminado).

Ejemplo de Uso

Uso Básico

import { getEnumeration } from "intlayer";const content = getEnumeration(  {    "<=-2.3": "Tienes menos de -2.3",    "<1": "Tienes menos de uno",    "2": "Tienes dos",    ">=3": "Tienes tres o más",  },  2);console.log(content); // Salida: "Tienes dos"

Prioridad de Condiciones

import { getEnumeration } from "intlayer";const content = getEnumeration(  {    "<4": "Tienes menos de cuatro",    "2": "Tienes dos",  },  2);console.log(content); // Salida: "Tienes menos de cuatro"

Casos Especiales

• Sin Condición Coincidente:

  • Si ninguna condición coincide con la cantidad proporcionada, la función devolverá undefined o manejará explícitamente el escenario predeterminado.

• 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 analizables como condiciones. Las 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.