--- title: URLSearchParams slug: Web/API/URLSearchParams translation_of: Web/API/URLSearchParams ---

{{ApiRef("URL API")}}

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

Construtor

{{domxref("URLSearchParams.URLSearchParams", '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.

{{domxref("URLSearchParams.append()")}}
Adiciona um par chave/valor como um novo parâmetro de pesquisa.
{{domxref("URLSearchParams.delete()")}}
Elimina o parâmetro de pesquisa e o seu valor, da lista de parâmetros de pesquisa.
{{domxref("URLSearchParams.entries()")}}
Devolve um {{jsxref("Iteration_protocols","iterator")}} que permite iterar pelos pares chave/valor neste objeto.
{{domxref("URLSearchParams.get()")}}
Devolve o primeiro valor relacionado com o parâmetro de pesquisa enviado.
{{domxref("URLSearchParams.getAll()")}}
Devolve todos os valores relacionados com um determinado parâmetro de pesquisa.
{{domxref("URLSearchParams.has()")}}
Devolve um {{jsxref("Boolean")}} , indicando de um determinado parâmetro de pesquisa existe.
{{domxref("URLSearchParams.keys()")}}
Devolve um {{jsxref("Iteration_protocols", "iterator")}} permitindo interar pelas chaves de todos os pares chave/valor existentes no objeto.
{{domxref("URLSearchParams.set()")}}
Define o valor associado a um parâmetro de pesquisa. Elimina outros valores se existirem.
{{domxref("URLSearchParams.toString()")}}
Devolve uma string com os parâmetros válidos para serem utilizados num URL.
{{domxref("URLSearchParams.values()")}}
Devolve um {{jsxref("Iteration_protocols", "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 parâmetros 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

Especificação Estado Comentário
{{SpecName('URL', '#urlsearchparams', "URLSearchParams")}} {{Spec2('URL')}} Definição inicial.

Compatibilidade Browsers

{{ CompatibilityTable() }}

Funcionalidade Chrome Firefox (Gecko) Internet Explorer Opera Safari
Suporte básico {{CompatChrome(49)}} {{CompatGeckoDesktop("29.0")}} {{CompatNo}} 36 10.1
entries(), keys(), values(), e suporte de for...of {{CompatChrome(49)}} {{CompatGeckoDesktop("44.0")}} {{CompatNo}} 36 {{CompatUnknown}}
USVString for constructor init object {{CompatVersionUnknown}} {{CompatGeckoDesktop("53.0")}} {{CompatNo}} {{CompatVersionUnknown}} {{CompatUnknown}}
Record for constructor init object {{CompatUnknown}} {{CompatGeckoDesktop("54.0")}} {{CompatNo}} {{CompatUnknown}} {{CompatUnknown}}
Funcionalidade Android Android Webview Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile Chrome para Android
Suporte básico {{CompatNo}} {{CompatChrome(49)}} {{CompatGeckoMobile("29.0")}} {{CompatNo}} {{CompatUnknown}} {{CompatNo}} {{CompatChrome(49)}}
entries(), keys(), values(), e suport de for...of {{CompatNo}} {{CompatChrome(49)}} {{CompatGeckoMobile("44.0")}} {{CompatNo}} {{CompatUnknown}} {{CompatNo}} {{CompatChrome(49)}}
USVString for constructor init object {{CompatNo}} {{CompatVersionUnknown}} {{CompatGeckoMobile("53.0")}} {{CompatNo}} {{CompatUnknown}} {{CompatUnknown}} {{CompatVersionUnknown}}
Record for constructor init object {{CompatNo}} {{CompatUnknown}} {{CompatGeckoMobile("54.0")}} {{CompatNo}} {{CompatUnknown}} {{CompatUnknown}} {{CompatUnknown}}

Ver também