String.prototype.localeCompare()
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2017.
Die localeCompare()
-Methode von String
-Werten gibt eine Zahl zurück, die anzeigt, ob diese Zeichenfolge vor, nach oder gleich der angegebenen Zeichenfolge in der Sortierreihenfolge steht. In Implementierungen mit Unterstützung für die Intl.Collator
API ruft diese Methode einfach Intl.Collator
auf.
Beim Vergleich großer Mengen von Zeichenfolgen, wie beim Sortieren großer Arrays, ist es besser, ein Intl.Collator
-Objekt zu erstellen und die von dessen compare()
-Methode bereitgestellte Funktion zu verwenden.
Probieren Sie es aus
Syntax
localeCompare(compareString)
localeCompare(compareString, locales)
localeCompare(compareString, locales, options)
Parameter
Die Parameter locales
und options
passen das Verhalten der Funktion an und ermöglichen Anwendungen die Angabe der Sprache, deren Formatierungskonventionen verwendet werden sollen.
In Implementierungen, die die Intl.Collator
API unterstützen, entsprechen diese Parameter genau den Parametern des Intl.Collator()
-Konstruktors. Implementierungen ohne Intl.Collator
-Unterstützung werden gebeten, beide Parameter zu ignorieren, was das zurückgegebene Vergleichsergebnis vollständig implementationsabhängig macht – es muss nur konsistent sein.
compareString
-
Die Zeichenfolge, mit der
referenceStr
verglichen wird. Alle Werte werden in Zeichenfolgen umgewandelt, sodass das Weglassen oder Übergeben vonundefined
dazu führt, dasslocaleCompare()
mit der Zeichenfolge"undefined"
vergleicht, was selten gewünscht ist. locales
Optional-
Eine Zeichenfolge mit einem BCP 47-Sprach-Tag oder ein Array solcher Zeichenfolgen. Entspricht dem
locales
-Parameter desIntl.Collator()
-Konstruktors.In Implementierungen ohne Unterstützung für
Intl.Collator
wird dieser Parameter ignoriert und in der Regel die Locale des Hosts verwendet. options
Optional-
Ein Objekt, das das Ausgabeformat anpasst. Entspricht dem
options
-Parameter desIntl.Collator()
-Konstruktors.In Implementierungen ohne Unterstützung für
Intl.Collator
wird dieser Parameter ignoriert.
Siehe den Intl.Collator()
-Konstruktor für Details zu den Parametern locales
und options
und wie sie verwendet werden.
Rückgabewert
Eine negative Zahl, wenn referenceStr
vor compareString
steht; positiv, wenn referenceStr
nach compareString
steht; 0
, wenn sie gleichwertig sind.
In Implementierungen mit Intl.Collator
entspricht dies new Intl.Collator(locales, options).compare(referenceStr, compareString)
.
Beschreibung
Gibt eine Ganzzahl zurück, die angibt, ob referenceStr
vor, nach oder gleichwertig mit compareString
ist.
-
Negativ, wenn
referenceStr
vorcompareString
steht. -
Positiv, wenn
referenceStr
nachcompareString
steht. - Gibt
0
zurück, wenn sie gleichwertig sind.
Warnung: Verlassen Sie sich nicht auf die exakten Rückgabewerte von -1
oder 1
!
Negative und positive Ganzzahlergebnisse variieren zwischen Browsern (sowie zwischen
Browserversionen), da die ECMAScript-Spezifikation nur negative und positive
Werte vorschreibt. Einige Browser könnten -2
oder 2
zurückgeben oder sogar
einen anderen negativen oder positiven Wert.
Beispiele
Verwendung von localeCompare()
// The letter "a" is before "c" yielding a negative value
"a".localeCompare("c"); // -2 or -1 (or some other negative value)
// Alphabetically the word "check" comes after "against" yielding a positive value
"check".localeCompare("against"); // 2 or 1 (or some other positive value)
// "a" and "a" are equivalent yielding a neutral value of zero
"a".localeCompare("a"); // 0
Ein Array sortieren
localeCompare()
ermöglicht eine Groß-/Kleinschreibungs-unabhängige Sortierung eines Arrays.
const items = ["réservé", "Premier", "Cliché", "communiqué", "café", "Adieu"];
items.sort((a, b) => a.localeCompare(b, "fr", { ignorePunctuation: true }));
// ['Adieu', 'café', 'Cliché', 'communiqué', 'Premier', 'réservé']
Überprüfen der Browser-Unterstützung für erweiterte Argumente
Die locales
- und options
-Argumente werden
noch nicht in allen Browsern unterstützt.
Um zu prüfen, ob eine Implementierung sie unterstützt, verwenden Sie das "i"
-Argument (eine
Voraussetzung, dass ungültige Sprach-Tags abgelehnt werden) und suchen Sie nach einer
RangeError
-Ausnahme:
function localeCompareSupportsLocales() {
try {
"foo".localeCompare("bar", "i");
} catch (e) {
return e.name === "RangeError";
}
return false;
}
Verwendung von Sprachumgebungen
Die Ergebnisse von localeCompare()
variieren zwischen den Sprachen. Um die Sortierreihenfolge der Sprache zu erhalten, die in der Benutzeroberfläche Ihrer Anwendung verwendet wird,
stellen Sie sicher, dass Sie diese Sprache (und möglicherweise einige Ersatzsprachen) mit dem
locales
-Argument angeben:
console.log("ä".localeCompare("z", "de")); // a negative value: in German, ä sorts before z
console.log("ä".localeCompare("z", "sv")); // a positive value: in Swedish, ä sorts after z
Verwendung von Optionen
Die Ergebnisse von localeCompare()
können mit dem
options
-Argument angepasst werden:
// in German, ä has a as the base letter
console.log("ä".localeCompare("a", "de", { sensitivity: "base" })); // 0
// in Swedish, ä and a are separate base letters
console.log("ä".localeCompare("a", "sv", { sensitivity: "base" })); // a positive value
Numerische Sortierung
// by default, "2" > "10"
console.log("2".localeCompare("10")); // 1
// numeric using options:
console.log("2".localeCompare("10", undefined, { numeric: true })); // -1
// numeric using locales tag:
console.log("2".localeCompare("10", "en-u-kn-true")); // -1
Spezifikationen
Specification |
---|
ECMAScript Language Specification # sec-string.prototype.localecompare |
ECMAScript Internationalization API Specification # sup-String.prototype.localeCompare |
Browser-Kompatibilität
BCD tables only load in the browser