--- title: URLSearchParams slug: Web/API/URLSearchParams tags: - API - Experimentell - Interface - Referenz - URL API translation_of: Web/API/URLSearchParams ---

{{ApiRef("URL API")}}

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

Ein Objekt, welches URLSearchParams implementiert, kann auch direkt in einem {{jsxref("Statements/for...of", "for...of")}} Konstrukt genutzt werden, anstatt {{domxref('URLSearchParams.entries()', 'entries()')}}: for (var p of mySearchParams) ist äquivalent zu for (var p of mySearchParams.entries()).

Konstruktor

{{domxref("URLSearchParams.URLSearchParams", 'URLSearchParams()')}}
Konstruktor erzeugt ein URLSearchParams Objekt von einem Query-String.

Eigenschaften

Dieses Interface erbt keine Eigenschaften.

Methoden

Dieses Interface erbt keine Methoden.

{{domxref("URLSearchParams.append()")}}
Hängt ein Schlüssel/Wert - Paar an den Query-String.
{{domxref("URLSearchParams.delete()")}}
Löscht einen Schlüssel und den zugehörigen Wert aus dem Query-String.
{{domxref("URLSearchParams.entries()")}}
Gibt einen {{jsxref("Iteration_protocols","Iterator")}} über alle Schlüssel/Wert - Paare im Query-String.
{{domxref("URLSearchParams.get()")}}
Gibt den ersten Wert, der im Query-String mit einem Schlüssel assoziiert ist.
{{domxref("URLSearchParams.getAll()")}}
Gibt alle Werte, die im Query-String mit einem Schlüssel assoziiert sind.
{{domxref("URLSearchParams.has()")}}
Gibt einen {{jsxref("Boolean")}}, der anzeigt ob ein Schlüssel im Query-String vorkommt.
{{domxref("URLSearchParams.keys()")}}
Gibt einen {{jsxref("Iteration_protocols", "Iterator")}} über alle Schlüssel im Query-String.
{{domxref("URLSearchParams.set()")}}
Setzt den Wert eines Schlüssels. Wenn der Schlüssel mehrfach im Query-String vorkommt, werden die Restlichen gelöscht.
{{domxref("URLSearchParams.sort()")}}
Sortiert alle Schlüssel/Wert Paare, nach dem Schlüssel.
Sorts all key/value pairs, if any, by their keys.
{{domxref("URLSearchParams.toString()")}}
Gibt den Query-String, in der passenden Form um in einer URL einzusetzen.
{{domxref("URLSearchParams.values()")}}
Gibt einen {{jsxref("Iteration_protocols", "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

Spezifikation Status Kommentar
{{SpecName('URL', '#urlsearchparams', "URLSearchParams")}} {{Spec2('URL')}} Initial definition.

Browser Kompatibilität

{{ CompatibilityTable() }}

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support {{CompatChrome(49)}} {{CompatGeckoDesktop("29.0")}} {{CompatNo}} 36 10.1
entries(), keys(), values(), and support of for...of {{CompatChrome(49)}} {{CompatGeckoDesktop("44.0")}} {{CompatNo}} 36 {{CompatUnknown}}
USVString for constructor init object {{CompatVersionUnknown}} {{CompatGeckoDesktop("53.0")}} {{CompatNo}} {{CompatVersionUnknown}} {{CompatUnknown}}
Record for constructor init object {{CompatNo}} {{CompatGeckoDesktop("54.0")}} {{CompatNo}} {{CompatUnknown}} {{CompatUnknown}}
Feature Android Webview Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Basic support {{CompatChrome(49)}} {{CompatChrome(49)}} {{CompatGeckoMobile("29.0")}} {{CompatNo}} {{CompatUnknown}} {{CompatNo}}
entries(), keys(), values(), and support of for...of {{CompatChrome(49)}} {{CompatChrome(49)}} {{CompatGeckoMobile("44.0")}} {{CompatNo}} {{CompatUnknown}} {{CompatNo}}
USVString for constructor init object {{CompatVersionUnknown}} {{CompatVersionUnknown}} {{CompatGeckoMobile("53.0")}} {{CompatNo}} {{CompatUnknown}} {{CompatUnknown}}
Record for constructor init object {{CompatUnknown}} {{CompatUnknown}} {{CompatGeckoMobile("54.0")}} {{CompatNo}} {{CompatUnknown}} {{CompatUnknown}}

Verweise