Documentation: getEnumerationContent Fonction dans intlayer

Description:

La fonction getEnumerationContent récupère le contenu correspondant à une quantité spécifique basée sur des conditions prédéfinies dans un objet d'énumération. Les conditions sont définies comme des clés, et leur priorité est déterminée par leur ordre dans l'objet.

Paramètres:

enumerationContent: QuantityContent<Content>
- Description: Un objet où les clés représentent les conditions (par exemple, <=, <, >=, =) et les valeurs représentent le contenu correspondant. L'ordre des clés définit leur priorité de correspondance.
- Type: QuantityContent<Content>
  - Content peut être de tout type.
quantity: number
- Description: La valeur numérique utilisée pour correspondre aux conditions dans enumerationContent.
- Type: number

Retourne:

Type: Content
Description: Le contenu correspondant à la première condition correspondante dans le enumerationContent. Si aucune correspondance n'est trouvée, cela revient à gérer selon l'implémentation (par exemple, erreur ou contenu de secours).

Exemple d'Utilisation:

Utilisation de Base:

typescript

1import { getEnumerationContent } from "@intlayer/config/client";
2
3const content = getEnumerationContent(
4  {
5    "<=-2.3": "Vous avez moins de -2.3",
6    "<1": "Vous avez moins d'un",
7    "2": "Vous avez deux",
8    ">=3": "Vous avez trois ou plus",
9  },
10  2
11);
12
13console.log(content); // Sortie: "Vous avez deux"

Priorité des Conditions:

typescript

1const content = getEnumerationContent(
2  {
3    "<4": "Vous avez moins de quatre",
4    "2": "Vous avez deux",
5  },
6  2
7);
8
9console.log(content); // Sortie: "Vous avez moins de quatre"

Cas Particuliers:

Aucune Condition Correspondante:
- Si aucune condition ne correspond à la quantité fournie, la fonction renverra soit undefined soit gérera explicitement le scénario par défaut/au secours.
Conditions Ambiguës:
- Si les conditions se chevauchent, la première condition correspondante (en fonction de l'ordre de l'objet) a la priorité.
Clés Invalides:
- La fonction suppose que toutes les clés dans enumerationContent sont valides et analysables en tant que conditions. Des clés invalides ou mal formatées peuvent entraîner un comportement inattendu.
Application TypeScript:
- La fonction garantit que le type Content est cohérent à travers toutes les clés, permettant une sécurité de type dans le contenu récupéré.

Notes:

L'utilitaire findMatchingCondition est utilisé pour déterminer la condition appropriée basée sur la quantité donnée.

Si vous avez une idée d’amélioration pour améliorer cette documentation, n’hésitez pas à contribuer en submitant une pull request sur GitHub.

Lien GitHub de la documentation

getTranslationContent getHTMLTextDir