Documentação: getEnumerationContent Função em intlayer

    Descrição:

    A função getEnumerationContent recupera o conteúdo correspondente a uma quantidade específica com base em condições predefinidas em um objeto de enumeração. As condições são definidas como chaves, e sua prioridade é determinada pela sua ordem no objeto.

    Parâmetros:

    • enumerationContent: QuantityContent<Content>

      • Descrição: Um objeto onde as chaves representam condições (por exemplo, <=, <, >=, =) e os valores representam o conteúdo correspondente. A ordem das chaves define sua prioridade de correspondência.
      • Tipo: QuantityContent<Content>
        • Content pode ser de qualquer tipo.
    • quantity: number

      • Descrição: O valor numérico usado para corresponder às condições em enumerationContent.
      • Tipo: number

    Retornos:

    • Tipo: Content
    • Descrição: O conteúdo correspondente à primeira condição correspondente em enumerationContent. Se nenhuma correspondência for encontrada, ele retorna para o tratamento com base na implementação (por exemplo, erro ou conteúdo de fallback).

    Exemplo de Uso:

    Uso Básico:

    typescript
    import { getEnumerationContent } from "intlayer";const content = getEnumerationContent(  {    "<=-2.3": "Você tem menos que -2.3",    "<1": "Você tem menos que um",    "2": "Você tem dois",    ">=3": "Você tem três ou mais",  },  2);console.log(content); // Saída: "Você tem dois"

    Prioridade das Condições:

    typescript
    import { getEnumerationContent } from "intlayer";const content = getEnumerationContent(  {    "<4": "Você tem menos que quatro",    "2": "Você tem dois",  },  2);console.log(content); // Saída: "Você tem menos que quatro"

    Casos Extremas:

    • Nenhuma Condição Correspondente:

      • Se nenhuma condição corresponder à quantidade fornecida, a função retornará undefined ou lidará com o cenário padrão/fallback explicitamente.
    • Condições Ambíguas:

      • Se as condições se sobrepuserem, a primeira condição correspondente (com base na ordem do objeto) terá precedência.
    • Chaves Inválidas:

      • A função assume que todas as chaves em enumerationContent são válidas e podem ser analisadas como condições. Chaves inválidas ou mal formatadas podem levar a comportamento inesperado.
    • Aplicação de TypeScript:

      • A função garante que o tipo Content seja consistente em todas as chaves, permitindo segurança de tipo no conteúdo recuperado.

    Notas:

    • A utilidade findMatchingCondition é usada para determinar a condição apropriada com base na quantidade dada.

    Se você tiver uma ideia para melhorar esta documentação, sinta-se à vontade para contribuir enviando uma pull request no GitHub.

    Link do GitHub para a documentação