aboutsummaryrefslogtreecommitdiff
path: root/files/pt-br/web/api/urlsearchparams/index.html
blob: 00080b0ae593eb7141d143295115877c73588021 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
---
title: URLSearchParams
slug: Web/API/URLSearchParams
tags:
  - API
  - API de URL
  - Experimental
  - Interface
  - Referencia
translation_of: Web/API/URLSearchParams
---
<p>{{ApiRef("URL API")}}</p>

<p>A interface <strong><code>URLSearchParams</code></strong> define métodos de utilização para trabalhar com query string de uma URL.</p>

<p>Uma implementação do objeto <code>URLSearchParams</code> pode diretamente ser usado em uma estrutura {{jsxref("Statements/for...of", "for...of")}}, em vez de {{domxref('URLSearchParams.entries()', 'entries()')}}: <code>for (var p of mySearchParams)</code> é equivalente de <code>for (var p of mySearchParams.entries())</code>.</p>

<h2 id="Construtor">Construtor</h2>

<dl>
 <dt>{{domxref("URLSearchParams.URLSearchParams", 'URLSearchParams()')}}</dt>
 <dd>Construtor retorna um objeto <code>URLSearchParams</code>.</dd>
</dl>

<h2 id="Propriedades">Propriedades</h2>

<p><em>Esta interface não herda nenhuma propriedade.</em></p>

<h2 id="Métodos">Métodos</h2>

<p><em>Esta interface não herda nenhum método.</em></p>

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

<h2 id="Exemplo">Exemplo</h2>

<pre class="brush: js">var stringParams = "q=URLUtils.searchParams&amp;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&amp;topic=api&amp;topic=webdev"
paramsBusca.set("topic", "More webdev");
paramsBusca.toString(); // "q=URLUtils.searchParams&amp;topic=More+webdev"
paramsBusca.delete("topic");
paramsBusca.toString(); // "q=URLUtils.searchParams"
</pre>

<h2 id="Especificações">Especificações</h2>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">Especificação</th>
   <th scope="col">Situação</th>
   <th scope="col">Comentário</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td>{{SpecName('URL', '#urlsearchparams', "URLSearchParams")}}</td>
   <td>{{Spec2('URL')}}</td>
   <td>Initial definition.</td>
  </tr>
 </tbody>
</table>

<h2 id="Compatibilidade_do_navegador">Compatibilidade do navegador</h2>

<p>{{ CompatibilityTable() }}</p>

<div id="compat-desktop">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Característica</th>
   <th>Chrome</th>
   <th>Firefox (Gecko)</th>
   <th>Internet Explorer</th>
   <th>Opera</th>
   <th>Safari</th>
  </tr>
  <tr>
   <td>Suporte básico</td>
   <td>{{CompatChrome(49)}}</td>
   <td>{{CompatGeckoDesktop("29.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>36</td>
   <td>{{CompatNo}}</td>
  </tr>
  <tr>
   <td><code>entries()</code>, <code>keys()</code>, <code>values()</code>, e suporte de <code>for...of</code></td>
   <td>{{CompatChrome(49)}}</td>
   <td>{{CompatGeckoDesktop("44.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>36</td>
   <td>{{CompatNo}}</td>
  </tr>
 </tbody>
</table>
</div>

<div id="compat-mobile">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Característica</th>
   <th>Android</th>
   <th>Android Webview</th>
   <th>Firefox Mobile (Gecko)</th>
   <th>IE Mobile</th>
   <th>Opera Mobile</th>
   <th>Safari Mobile</th>
   <th>Chrome for Android</th>
  </tr>
  <tr>
   <td>Suporte básico</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatChrome(49)}}</td>
   <td>{{CompatGeckoMobile("29.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatChrome(49)}}</td>
  </tr>
  <tr>
   <td><code>entries()</code>, <code>keys()</code>, <code>values()</code>, e suporte de <code>for...of</code></td>
   <td>{{CompatNo}}</td>
   <td>{{CompatChrome(49)}}</td>
   <td>{{CompatGeckoMobile("44.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatChrome(49)}}</td>
  </tr>
 </tbody>
</table>
</div>

<h2 id="Veja_também">Veja também</h2>

<ul>
 <li>Outras interfaces relacionadas com URL: {{domxref("URL")}}, {{domxref("URLUtils")}}.</li>
 <li><a href="https://developers.google.com/web/updates/2016/01/urlsearchparams?hl=en">Google Developers: Easy URL manipulation with URLSearchParams</a></li>
</ul>

<dl>
</dl>