String.prototype.localeCompare()

Probieren Sie es aus

const a = "rserv"; // 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

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

Parameter

Die Parameter locales und options passen das Verhalten der Funktion an und ermglichen es Anwendungen, die Sprache anzugeben, deren Formatierungskonventionen verwendet werden sollen.

In Implementierungen, die die Intl.Collator API untersttzen, entsprechen diese Parameter genau den Parametern des Intl.Collator() Konstruktors. Implementierungen ohne Intl.Collator Untersttzung sollten beide Parameter ignorieren, was dazu fhrt, dass das zurckgegebene Vergleichsergebnis vollstndig von der Implementierung abhngt es muss lediglich konsistent sein.

compareString

Die Zeichenkette, mit der referenceStr verglichen wird. Alle Werte werden in Zeichenketten umgewandelt, daher fhrt das Auslassen oder bergeben von undefined dazu, dass localeCompare() mit der Zeichenkette "undefined" vergleicht, was selten erwnscht ist.

locales Optional

Eine Zeichenkette mit einem BCP 47-Sprachtag oder ein Array solcher Zeichenketten. Entspricht dem locales Parameter des Intl.Collator() Konstruktors.

In Implementierungen ohne Intl.Collator Untersttzung wird dieser Parameter ignoriert und normalerweise die Locale des Hosts verwendet.

options Optional

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

In Implementierungen ohne Intl.Collator Untersttzung wird dieser Parameter ignoriert.

Siehe den Intl.Collator() Konstruktor fr Details zu den locales und options Parametern und wie man sie verwendet.

Rckgabewert

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 ganze Zahl zurck, die angibt, ob referenceStr vor, nach oder gleichwertig mit compareString kommt.

• Negativ, wenn referenceStr vor compareString steht
• Positiv, wenn referenceStr nach compareString steht
• Gibt 0 zurck, wenn sie gleichwertig sind

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() ermglicht eine Gro- und Kleinschreibung ignorierende Sortierung eines Arrays.

const items = ["rserv", "Premier", "Clich", "communiqu", "caf", "Adieu"];
items.sort((a, b) => a.localeCompare(b, "fr", { ignorePunctuation: true }));
// ['Adieu', 'caf', 'Clich', 'communiqu', 'Premier', 'rserv']

Browser-Untersttzung fr erweiterte Argumente prfen

Die Argumente locales und options werden noch nicht in allen Browsern untersttzt.

Um zu prfen, ob eine Implementierung sie untersttzt, verwenden Sie das "i" Argument (ein Erfordernis, dass ungltige Sprach-Tags abgelehnt werden) und suchen nach einer RangeError Ausnahme:

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

Verwendung von locales

Die Ergebnisse, die durch localeCompare() bereitgestellt werden, variieren zwischen den Sprachen. Um die Sortierreihenfolge der in der Benutzeroberflche Ihrer Anwendung verwendeten Sprache zu erhalten, stellen Sie sicher, dass Sie diese Sprache (und mglicherweise einige Fallback-Sprachen) 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 options

Die von localeCompare() bereitgestellten Ergebnisse knnen 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

Browser-Kompatibilitt

Siehe auch

• Intl.Collator