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 Methode localeCompare() von String-Werten gibt eine Zahl zurück, die angibt, ob dieser String vor, nach oder gleich dem angegebenen String in der Sortierreihenfolge liegt. In Implementierungen, die die Intl.Collator API unterstützen, delegiert diese Methode an Intl.Collator.

Bei der Bearbeitung großer Datenmengen, wie dem Sortieren von großen Arrays, ist es besser, ein Intl.Collator-Objekt zu erstellen und die durch seine compare()-Methode bereitgestellte Funktion zu verwenden.

Probieren Sie es aus

const a = "réservé"; // With accents, lowercase
const b = "RESERVE"; // No accents, uppercase

console.log(a.localeCompare(b));
// Expected output: 1
console.log(a.localeCompare(b, "en", { sensitivity: "base" }));
// Expected output: 0

Syntax

js
localeCompare(compareString)
localeCompare(compareString, locales)
localeCompare(compareString, locales, options)

Parameter

Die Parameter locales und options passen das Verhalten der Funktion an und ermöglichen es Anwendungen, die Sprache zu bestimmen, deren Formatierungskonventionen verwendet werden sollen.

In Implementierungen, die die Intl.Collator API unterstützen, entsprechen diese Parameter exakt den Parametern des Konstruktors Intl.Collator(). In Implementierungen ohne Intl.Collator-Unterstützung werden beide Parameter ignoriert, wodurch das zurückgegebene Vergleichsergebnis vollständig implementierungsabhängig ist — es muss lediglich konsistent sein.

compareString

Der String, mit dem referenceStr verglichen wird. Alle Werte werden in Strings umgewandelt, sodass das Weglassen oder die Übergabe von undefined dazu führt, dass localeCompare() einen Vergleich mit dem String "undefined" durchführt, was selten gewünscht ist.

locales Optional

Ein String mit einem BCP 47-Sprach-Tag oder ein Array solcher Strings. Entspricht dem locales-Parameter des Intl.Collator()-Konstruktors.

In Implementierungen ohne Intl.Collator-Unterstützung wird dieser Parameter ignoriert, und die Locale des Hosts wird typischerweise verwendet.

options Optional

Ein Objekt, das das Ausgabeformat anpasst. Entspricht dem options-Parameter des Intl.Collator()-Konstruktors.

In Implementierungen ohne Intl.Collator-Unterstützung wird dieser Parameter ignoriert.

Details zu den Parametern locales und options und deren Verwendung finden Sie im Konstruktor Intl.Collator().

Rückgabewert

Eine negative Zahl, wenn referenceStr vor compareString kommt; positiv, wenn referenceStr nach compareString kommt; 0, wenn sie gleich 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 gleich compareString kommt.

  • Negativ, wenn referenceStr vor compareString kommt.
  • Positiv, wenn referenceStr nach compareString kommt.
  • Gibt 0 zurück, wenn sie gleichwertig sind.

Warnung: Verlassen Sie sich nicht auf die genauen Rückgabewerte von -1 oder 1!

Negative und positive Ganzzahlen können je nach Browser (und Browser-Version) variieren, da die ECMAScript-Spezifikation nur negative und positive Werte verlangt. Manche Browser können -2 oder 2 oder sogar andere negative oder positive Werte zurückgeben.

Beispiele

Verwendung von localeCompare()

js
// 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

Array sortieren

localeCompare() ermöglicht eine case-insensitive-Sortierung eines Arrays.

js
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é']

Unterstützung erweiterten Argumenten durch Browser prüfen

Die Argumente locales und options werden nicht in allen Browsern unterstützt.

Um zu überprüfen, ob eine Implementierung sie unterstützt, verwenden Sie das "i"-Argument (eine Anforderung, dass ungültige Sprach-Tags abgelehnt werden) und suchen nach einer RangeError-Ausnahme:

js
function localeCompareSupportsLocales() {
  try {
    "foo".localeCompare("bar", "i");
  } catch (e) {
    return e.name === "RangeError";
  }
  return false;
}

Verwendung von locales

Die von localeCompare() bereitgestellten Ergebnisse variieren zwischen 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-Parameter angeben:

js
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 options

Die von localeCompare() bereitgestellten Ergebnisse können mit dem options-Parameter angepasst werden:

js
// 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

Numerisches Sortieren

js
// 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® 2025 Language Specification
# sec-string.prototype.localecompare
ECMAScript® 2025 Internationalization API Specification
# sup-String.prototype.localeCompare

Browser-Kompatibilität

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
Node.js
localeCompare
locales parameter
options parameter

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
Partial support
Partial support
No support
No support
Has more compatibility info.

Siehe auch