La méthode JavaScript String localeCompare () vérifie si une chaîne donnée vient avant, après ou est identique à une autre chaîne dans l'ordre de tri.
La syntaxe de la localeCompare()
méthode est:
str.localeCompare(compareStr, locales, options)
Voici str
une chaîne.
Paramètres localeCompare ()
La localeCompare()
méthode prend en compte:
- compareStr - La chaîne à laquelle
str
est comparée. - locales et options (facultatif) - Ces arguments personnalisent la fonction en spécifiant les conventions de formatage à utiliser.
Valeur renvoyée par localeCompare ()
- Renvoie un nombre négatif (-1) si la chaîne de référence est triée avant compareStr.
- Renvoie 0 si deux chaînes sont équivalentes.
- Renvoie un nombre positif (1) si la chaîne de référence est triée après compareStr.
Remarque : étant donné que les entiers négatifs et positifs renvoyés varient d'un navigateur à l'autre, ne vous fiez pas aux valeurs exactes -1 ou 1 .
Exemple 1: Utilisation de localeCompare ()
// letter 'h' comes after 'c' let result = "h".localeCompare("c"); console.log(result); // 1 // letter 'a' comes before 'c', so 'after' comes before 'car' let result1 = "after".localeCompare("car"); console.log(result1); // words 'JavaScript' & 'JavaScript' are equivalent let result2 = "JavaScript".localeCompare("JavaScript"); console.log(result2); // 0
Production
1 -1 0
Exemple 2: Utilisation de localeCompare () avec les paramètres régionaux et les options
// using locale let value1 = "ä".localeCompare("z", "de"); console.log(value1); // a negative value: in German, ä sorts before z let value2 = "ä".localeCompare("z", "sv"); console.log(value2); // a positive value: in Swedish, ä sorts after z // default console.log("5".localeCompare("40")); // 1 // using options let value3 = "5".localeCompare("40", undefined, ( numeric: true )); console.log(value3); // a negative value let value4 = "Cliché".localeCompare("café", "fr", ( ignorePunctuation: true )); console.log(value4); // a positive value
Production
-1 -1 1 -1 1