URLSearchParams

Das URLSearchParams Interface definiert Hilfsmethoden um mit dem Query-String einer URL zu arbeiten.

Ein Objekt, welches URLSearchParams implementiert, kann auch direkt in einem for...of Konstrukt genutzt werden, anstatt entries(): for (var p of mySearchParams) ist äquivalent zu for (var p of mySearchParams.entries()).

Konstruktor

URLSearchParams()

Konstruktor erzeugt ein URLSearchParams Objekt von einem Query-String.

Eigenschaften

Dieses Interface erbt keine Eigenschaften.

Methoden

Dieses Interface erbt keine Methoden.

URLSearchParams.append()

Hängt ein Schlüssel/Wert - Paar an den Query-String.

URLSearchParams.delete()

Löscht einen Schlüssel und den zugehörigen Wert aus dem Query-String.

URLSearchParams.entries()

Gibt einen Iterator über alle Schlüssel/Wert - Paare im Query-String.

URLSearchParams.get()

Gibt den ersten Wert, der im Query-String mit einem Schlüssel assoziiert ist.

URLSearchParams.getAll()

Gibt alle Werte, die im Query-String mit einem Schlüssel assoziiert sind.

URLSearchParams.has()

Gibt einen Boolean, der anzeigt ob ein Schlüssel im Query-String vorkommt.

URLSearchParams.keys()

Gibt einen Iterator über alle Schlüssel im Query-String.

URLSearchParams.set()

Setzt den Wert eines Schlüssels. Wenn der Schlüssel mehrfach im Query-String vorkommt, werden die Restlichen gelöscht.

URLSearchParams.sort()

Sortiert alle Schlüssel/Wert Paare, nach dem Schlüssel.

Sorts all key/value pairs, if any, by their keys.

URLSearchParams.toString()

Gibt den Query-String, in der passenden Form um in einer URL einzusetzen.

URLSearchParams.values()

Gibt einen Iterator über alle Werte im Query-String.

Beispiel

var paramsString = "q=URLUtils.searchParams&topic=api"
var searchParams = new URLSearchParams(paramsString);

//Iteriert über die Suchparameter
for (let p of searchParams) {
  console.log(p);
}

searchParams.has("topic") === true; // true
searchParams.get("topic") === "api"; // true
searchParams.getAll("topic"); // ["api"]
searchParams.get("foo") === null; // true
searchParams.append("topic", "webdev");
searchParams.toString(); // "q=URLUtils.searchParams&topic=api&topic=webdev"
searchParams.set("topic", "More webdev");
searchParams.toString(); // "q=URLUtils.searchParams&topic=More+webdev"
searchParams.delete("topic");
searchParams.toString(); // "q=URLUtils.searchParams"

Spezifikationen

Browser Kompatibilität

Verweise

• Andere URL-bezogene Interfaces: URL, URLUtils.
• Google Developers: Easy URL manipulation with URLSearchParams