--- title: URLSearchParams slug: Web/API/URLSearchParams tags: - API - API de URL - Experimental - Interface - Referencia translation_of: Web/API/URLSearchParams ---

{{ApiRef("URL API")}}

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 {{jsxref("Statements/for...of", "for...of")}}, em vez de {{domxref('URLSearchParams.entries()', 'entries()')}}: for (var p of mySearchParams) é equivalente de for (var p of mySearchParams.entries()).

Construtor

{{domxref("URLSearchParams.URLSearchParams", 'URLSearchParams()')}}
Construtor retorna um objeto URLSearchParams.

Propriedades

Esta interface não herda nenhuma propriedade.

Métodos

Esta interface não herda nenhum método.

{{domxref("URLSearchParams.append()")}}
Acrescenta um par de chave/valor específica com um novo parâmetro de busca.
{{domxref("URLSearchParams.delete()")}}
Exclui o parâmetro de busca informado, e seu valor associado, da lista de parâmetros de busca.
{{domxref("URLSearchParams.entries()")}}
Retorna um {{jsxref("Iteration_protocols","iterator")}} permitindo obter por todos os pares de chave/valor contidos neste objeto.
{{domxref("URLSearchParams.get()")}}
Retorna o primeiro valor associado ao parâmetro de busca informado.
{{domxref("URLSearchParams.getAll()")}}
Retorna todos os valores associados com o parâmetro de busca encontrado.
{{domxref("URLSearchParams.has()")}}
Retorna um {{jsxref("Boolean")}} indicando se cada um dos parâmetros de busca existe.
{{domxref("URLSearchParams.keys()")}}
Retorna um {{jsxref("Iteration_protocols", "iterator")}} permitindo obter todas as chaves dos pares de chave/valor contido neste objeto.
{{domxref("URLSearchParams.set()")}}
Define o valor associado ao parâmetro de busca com o valor informado. Se tiver mutios valores, exclua os outros.
{{domxref("URLSearchParams.toString()")}}
Retorna uma string contendo uma query string adequada pra usar numa URL.
{{domxref("URLSearchParams.values()")}}
Retorna um {{jsxref("Iteration_protocols", "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

Especificação Situação Comentário
{{SpecName('URL', '#urlsearchparams', "URLSearchParams")}} {{Spec2('URL')}} Initial definition.

Compatibilidade do navegador

{{ CompatibilityTable() }}

Característica Chrome Firefox (Gecko) Internet Explorer Opera Safari
Suporte básico {{CompatChrome(49)}} {{CompatGeckoDesktop("29.0")}} {{CompatNo}} 36 {{CompatNo}}
entries(), keys(), values(), e suporte de for...of {{CompatChrome(49)}} {{CompatGeckoDesktop("44.0")}} {{CompatNo}} 36 {{CompatNo}}
Característica Android Android Webview Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile Chrome for Android
Suporte básico {{CompatNo}} {{CompatChrome(49)}} {{CompatGeckoMobile("29.0")}} {{CompatNo}} {{CompatUnknown}} {{CompatNo}} {{CompatChrome(49)}}
entries(), keys(), values(), e suporte de for...of {{CompatNo}} {{CompatChrome(49)}} {{CompatGeckoMobile("44.0")}} {{CompatNo}} {{CompatUnknown}} {{CompatNo}} {{CompatChrome(49)}}

Veja também