URLSearchParams

Baseline Widely available *

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

* Some parts of this feature may have varying levels of support.

L'interface URLSearchParams définit des méthodes utilitaires pour travailler avec la chaîne de requête (les paramètres GET) d'une URL.

Un objet implémentant URLSearchParams peut être directement utilisé dans une structure for...of, au lieu de entries() : for (var p of mySearchParams) ou son équivalent for (var p of mySearchParams.entries()).

Constructeur

URLSearchParams()

Constructeur renvoyant un objet URLSearchParams.

Propriétés

Cette interface n'hérite d'aucune propriété.

Méthodes

Cette interface n'hérite d'aucune méthode.

URLSearchParams.append()

Ajoute une paire clé / valeur spécifiée en tant que nouveau paramètre de recherche.

URLSearchParams.delete()

Supprime le paramètre de recherche donné et sa valeur associée de la liste de tous les paramètres de recherche.

URLSearchParams.entries()

Retourne un iterator permettant de parcourir toutes les paires clé / valeur contenues dans cet objet.

URLSearchParams.get()

Retourne la première valeur associée au paramètre de recherche donné.

URLSearchParams.getAll()

Retourne toutes les valeurs associées au paramètre de recherche donné.

URLSearchParams.has()

Retourne un Boolean indiquant si un tel paramètre de recherche existe.

URLSearchParams.keys()

Retourne un iterator permettant de parcourir toutes les clés des paires clé / valeur contenues dans cet objet.

URLSearchParams.set()

Définit la valeur associée à un paramètre de recherche donné à la valeur donnée. S'il y avait plusieurs valeurs, les autres sont supprimées.

URLSearchParams.sort()

Trie toutes les paires clé / valeur, s'il y en a, par leurs clés.

URLSearchParams.toString()

Retourne une chaîne contenant une chaîne de requête pouvant être utilisée dans une URL.

URLSearchParams.values()

Retourne un iterator permettant de parcourir toutes les valeurs des paires clé / valeur contenues dans cet objet.

Exemple

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

// Itère sur les paramètres de recherche.
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"

Spécifications

Specification
URL
# urlsearchparams

Compatibilité des navigateurs

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
URLSearchParams
[Symbol.iterator]
URLSearchParams() constructor
USVString for init object
record for init object
sequence for init object
append
delete
value parameter
entries
forEach
get
getAll
has
value parameter
keys
set
size
sort
toString
values

Legend

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

Full support
Full support
Partial support
Partial support
No support
No support
See implementation notes.
Has more compatibility info.

Voir aussi