URLSearchParams

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() (en-US)

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() (en-US)

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

URLSearchParams.delete() (en-US)

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() (en-US)

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

URLSearchParams.getAll() (en-US)

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

URLSearchParams.has() (en-US)

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

URLSearchParams.keys() (en-US)

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

URLSearchParams.set() (en-US)

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() (en-US)

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

URLSearchParams.toString() (en-US)

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

URLSearchParams.values() (en-US)

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

Exemple

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

Spécification Statut Commentaire
URL
La définition de 'URLSearchParams' dans cette spécification.
Standard évolutif Définition initiale.

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi