URLSearchParams

A interface URLSearchParams define métodos de utilização para trabalhar com query string de uma URL.

Uma implementação do objeto URLSearchParams pode diretamente ser usado em uma estrutura for...of, em vez de entries(): for (var p of mySearchParams) é equivalente de for (var p of mySearchParams.entries()).

Construtor

URLSearchParams()

Construtor retorna um objeto URLSearchParams.

Propriedades

Esta interface não herda nenhuma propriedade.

Métodos

Esta interface não herda nenhum método.

URLSearchParams.append()

Acrescenta um par de chave/valor específica com um novo parâmetro de busca.

URLSearchParams.delete()

Exclui o parâmetro de busca informado, e seu valor associado, da lista de parâmetros de busca.

URLSearchParams.entries()

Retorna um iterator permitindo obter por todos os pares de chave/valor contidos neste objeto.

URLSearchParams.get()

Retorna o primeiro valor associado ao parâmetro de busca informado.

URLSearchParams.getAll()

Retorna todos os valores associados com o parâmetro de busca encontrado.

URLSearchParams.has()

Retorna um Boolean indicando se cada um dos parâmetros de busca existe.

URLSearchParams.keys()

Retorna um iterator permitindo obter todas as chaves dos pares de chave/valor contido neste objeto.

URLSearchParams.set()

Define o valor associado ao parâmetro de busca com o valor informado. Se tiver mutios valores, exclua os outros.

URLSearchParams.toString()

Retorna uma string contendo uma query string adequada pra usar numa URL.

URLSearchParams.values()

Retorna um iterator permitindo obter todos os valores dos pares de chave/valor contido neste objeto.

Exemplo

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

//Iterar os parâmetros de busca.
for (let p of paramsBusca) {
  console.log(p);
}

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

Especificações

Compatibilidade do navegador

Estamos convertendo nossos dados de compatibilidade para o formato JSON. Esta tabela de compatibilidade ainda usa o formato antigo, pois ainda não convertemos os dados que ela contém. Descubra como você pode ajudar!

Veja também

• Outras interfaces relacionadas com URL: URL, URLUtils.
• Google Developers: Easy URL manipulation with URLSearchParams