String.prototype.toWellFormed()

Syntax

toWellFormed()

Parameter

Keine.

Rckgabewert

Ein neuer String, der eine Kopie des ursprnglichen Strings ist, wobei alle einzelstehenden Surrogate durch das Unicode-Ersatzzeichen U+FFFD ersetzt wurden. Wenn str wohlgeformt ist, wird dennoch ein neuer String zurckgegeben (im Wesentlichen eine Kopie von str).

Beschreibung

Strings in JavaScript sind UTF-16-codiert. Die UTF-16-Codierung verwendet sogenannte Surrogatpaare, die im Abschnitt UTF-16-Zeichen, Unicode-Codepunkte und Graphemcluster ausfhrlich erlutert werden.

toWellFormed() durchluft die Codeeinheiten des Strings und ersetzt jedes einzelstehende Surrogat durch das Unicode-Ersatzzeichen U+FFFD . Dadurch ist der zurckgegebene String wohlgeformt und kann in Funktionen verwendet werden, die wohlgeformte Strings erwarten, beispielsweise encodeURI. Im Vergleich zu einer eigenen Implementierung ist toWellFormed() effizienter, da JavaScript-Engines direkt auf die interne Darstellung von Strings zugreifen knnen.

Wenn nicht wohlgeformte Strings in bestimmten Kontexten verwendet werden, etwa mit TextEncoder, werden sie automatisch mit demselben Ersatzzeichen in wohlgeformte Strings umgewandelt. Auch bei der Darstellung einzelstehender Surrogate wird das Ersatzzeichen angezeigt (eine Raute mit einem Fragezeichen darin).

Beispiele

toWellFormed() verwenden

const strings = [
  // Lone leading surrogate
  "ab\uD800",
  "ab\uD800c",
  // Lone trailing surrogate
  "\uDFFFab",
  "c\uDFFFab",
  // Well-formed
  "abc",
  "ab\uD83D\uDE04c",
];

for (const str of strings) {
  console.log(str.toWellFormed());
}
// Logs:
// "ab"
// "abc"
// "ab"
// "cab"
// "abc"
// "abc"

Fehler in encodeURI() vermeiden

encodeURI lst einen Fehler aus, wenn der bergebene String nicht wohlgeformt ist. Dies lsst sich vermeiden, indem Sie den String zuerst mit toWellFormed() in einen wohlgeformten String umwandeln.

const illFormed = "https://example.com/search?q=\uD800";

try {
  encodeURI(illFormed);
} catch (e) {
  console.log(e); // URIError: URI malformed
}

console.log(encodeURI(illFormed.toWellFormed())); // "https://example.com/search?q=%EF%BF%BD"

Spezifikationen

Browser-Kompatibilitt

Siehe auch

• Polyfill fr String.prototype.toWellFormed in core-js
• Polyfill fr String.prototype.toWellFormed von es-shims
• String.prototype.isWellFormed()
• String.prototype.normalize()