Документация: getEnumerationContent Функция в intlayer

    Описание:

    Функция getEnumerationContent извлекает контент, соответствующий определённому количеству на основе предопределенных условий в объекте перечисления. Условия определяются в качестве ключей, а их приоритет определяется порядком в объекте.

    Параметры:

    • enumerationContent: QuantityContent<Content>

      • Описание: Объект, в котором ключи представляют условия (например, <=, <, >=, =) и значения представляют соответствующий контент. Порядок ключей определяет их приоритет соответствия.
      • Тип: QuantityContent<Content>
        • Content может быть любого типа.
    • quantity: number

      • Описание: Числовое значение, используемое для сопоставления с условиями в enumerationContent.
      • Тип: number

    Возвращает:

    • Тип: Content
    • Описание: Контент, соответствующий первому совпадающему условию в enumerationContent. Если совпадение не найдено, он по умолчанию обрабатывает это в зависимости от реализации (например, ошибка или контент по умолчанию).

    Пример использования:

    Основное использование:

    typescript
    import { getEnumerationContent } from "intlayer";const content = getEnumerationContent(  {    "<=-2.3": "У вас меньше чем -2.3",    "<1": "У вас меньше одного",    "2": "У вас два",    ">=3": "У вас три или больше",  },  2);console.log(content); // Вывод: "У вас два"

    Приоритет условий:

    typescript
    import { getEnumerationContent } from "intlayer";const content = getEnumerationContent(  {    "<4": "У вас меньше четырех",    "2": "У вас два",  },  2);console.log(content); // Вывод: "У вас меньше четырех"

    Граничные случаи:

    • Нет совпадающего условия:

      • Если ни одно условие не соответствует предоставленному количеству, функция либо вернёт /ruundefined, либо явно обработает сценарий по умолчанию/резервному варианту.
    • Неоднозначные условия:

      • Если условия пересекаются, первое совпадающее условие (на основе порядка объекта) имеет преимущество.
    • Недопустимые ключи:

      • Функция предполагает, что все ключи в enumerationContent действительны и могут быть разобраны как условия. Неправильные или неправильно отформатированные ключи могут привести к неожиданному поведению.
    • Принуждение TypeScript:

      • Функция гарантирует, что тип Content последователен для всех ключей, что позволяет обеспечить безопасность типов в извлеченном контенте.

    Примечания:

    • Утилита findMatchingCondition используется для определения подходящего условия на основе данного количества.

    Если у вас есть идея по улучшению этой документации, не стесняйтесь внести свой вклад, подав запрос на вытягивание на GitHub.

    Ссылка на документацию GitHub