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 parâmetro de pesquisa.
URLSearchParams.delete()
- Elimina o parâmetro de pesquisa e o seu valor, da lista de parâmetros 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 parâmetro de pesquisa enviado.
URLSearchParams.getAll()
- Devolve todos os valores relacionados com um determinado parâmetro de pesquisa.
URLSearchParams.has()
- Devolve um
Boolean
, indicando de um determinado parâmetro 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 parâmetro de pesquisa. Elimina outros valores se existirem.
URLSearchParams.toString()
- Devolve uma string com os parâmetros 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 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 |
---|---|---|
URL The definition of 'URLSearchParams' in that specification. |
Living Standard | Definição inicial. |
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!
Funcionalidade | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Suporte básico | 49 | 29.0 (29.0) | No support | 36 | 10.1 |
entries() , keys() , values() , e suporte de for...of |
49 | 44.0 (44.0) | No support | 36 | ? |
USVString for constructor init object |
(Yes) | 53.0 (53.0) | No support | (Yes) | ? |
Record for constructor init object |
? | 54.0 (54.0) | No support | ? | ? |
Funcionalidade | Android | Android Webview | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile | Chrome para Android |
---|---|---|---|---|---|---|---|
Suporte básico | No support | 49 | 29.0 (29.0) | No support | ? | No support | 49 |
entries() , keys() , values() , e suport de for...of |
No support | 49 | 44.0 (44.0) | No support | ? | No support | 49 |
USVString for constructor init object |
No support | (Yes) | 53.0 (53.0) | No support | ? | ? | (Yes) |
Record for constructor init object |
No support | ? | 54.0 (54.0) | No support | ? | ? | ? |
Ver também
- Outros interfaces relacionados com URL:
URL
,URLUtils
. - Google Developers: Manipulação simples de URL com URLSearchParams