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

Descrição

A função getEnumeration 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 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 a prioridade de correspondência.
  • Tipo: QuantityContent<Content>
    • Content pode ser qualquer tipo.

• quantity: number

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

Retorno

• Tipo: Content
• Descrição: O conteúdo correspondente à primeira condição que coincidir em enumerationContent. Se nenhuma correspondência for encontrada, o comportamento padrão dependerá da implementação (por exemplo, erro ou conteúdo alternativo).

Exemplo de Uso

Uso Básico

import { getEnumeration } from "intlayer";

const content = getEnumeration(
  {
    "<=-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

import { getEnumeration } from "intlayer";

const content = getEnumeration(
  {
    "<4": "Você tem menos que quatro",
    "2": "Você tem dois",
  },
  2
);

console.log(content); // Saída: "Você tem menos que quatro"

Casos Especiais

• Nenhuma Condição Correspondente:

  • Se nenhuma condição corresponder à quantidade fornecida, a função retornará undefined ou tratará explicitamente o cenário padrão/fallback.

• 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 interpretadas como condições. Chaves inválidas ou com formato incorreto podem levar a comportamentos inesperados.

• Aplicação do 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 fornecida.