URLSearchParams

O interface URLSearchParams define métodos que permitem trabalhar com uma query string de um URL.

Um objeto que implemente URLSearchParams pode ser utilizado diretamente numa estrutura for...of, em vez de entries(): for (var p of mySearchParams) é equivalente a for (var p of mySearchParams.entries()).

Construtor

URLSearchParams()

O construtor devolve um objeto URLSearchParams.

Propriedades

Este interface não herda nehuma propriedade.

Métodos

Este interface não herda nehum método.

URLSearchParams.append()

Adiciona um par chave/valor como um novo paramêtro de pesquisa.

URLSearchParams.delete()

Elimina o paramêtro de pesquisa e o seu valor, da lista de paramêtros de pesquisa.

URLSearchParams.entries()

Devolve um iterator que permite iterar pelos pares chave/valor neste objeto.

URLSearchParams.get()

Devolve o primeiro valor relacionado com o paramêtro de pesquisa enviado.

URLSearchParams.getAll()

Devolve todos os valores relacionados com um determinado paramêtro de pesquisa.

URLSearchParams.has()

Devolve um Boolean , indicando de um determinado paramêtro de pesquisa existe.

URLSearchParams.keys()

Devolve um iterator permitindo interar pelas chaves de todos os pares chave/valor existentes no objeto.

URLSearchParams.set()

Define o valor associado a um paramêtro de pesquisa. Elimina outros valores se existirem.

URLSearchParams.toString()

Devolve uma string com os paramêtros válidos para serem utilizados num URL.

URLSearchParams.values()

Devolve um iterator que permite iterar por todos os valores dos pares chave/valor existentes neste objeto.

Exemplo

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

//Iterar pelos paramêtros de pesquisa.
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"

Especificações

Compatibilidade Browsers

We're converting our compatibility data into a machine-readable JSON format. This compatibility table still uses the old format, because we haven't yet converted the data it contains. Find out how you can help!

Ver também

• Outros interfaces relacionados com URL: URL, URLUtils.
• Google Developers: Manipulação simples de URL com URLSearchParams