aboutsummaryrefslogtreecommitdiff
path: root/files/pt-pt/web/api/urlsearchparams/index.html
blob: 3cbed3eea5ee6a63116a0f4b17e57ba205e6a8c2 (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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
---
title: URLSearchParams
slug: Web/API/URLSearchParams
translation_of: Web/API/URLSearchParams
---
<p>{{ApiRef("URL API")}}</p>

<p>O interface <strong><code>URLSearchParams </code></strong>define métodos que permitem trabalhar com uma <em>query string</em> de um URL.</p>

<p>Um objeto que implemente <code>URLSearchParams </code>pode ser utilizado diretamente numa estrutura {{jsxref("Statements/for...of", "for...of")}}, em vez de {{domxref('URLSearchParams.entries()', 'entries()')}}: <code>for (var p of mySearchParams) é equivalente a</code> <code>for (var p of mySearchParams.entries())</code>.</p>

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

<dl>
 <dt>{{domxref("URLSearchParams.URLSearchParams", 'URLSearchParams()')}}</dt>
 <dd>O construtor devolve um objeto <code>URLSearchParams</code>.</dd>
</dl>

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

<p><em>Este interface não herda nehuma propriedade.</em></p>

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

<p><em>Este interface não herda nehum método.</em></p>

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

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

<pre class="brush: js">var paramsString = "q=URLUtils.searchParams&amp;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&amp;topic=api&amp;topic=webdev"
searchParams.set("topic", "More webdev");
searchParams.toString(); // "q=URLUtils.searchParams&amp;topic=More+webdev"
searchParams.delete("topic");
searchParams.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">Estado</th>
   <th scope="col">Comentário</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td>{{SpecName('URL', '#urlsearchparams', "URLSearchParams")}}</td>
   <td>{{Spec2('URL')}}</td>
   <td>Definição inicial.</td>
  </tr>
 </tbody>
</table>

<h2 id="Compatibilidade_Browsers">Compatibilidade Browsers</h2>

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

<div id="compat-desktop">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Funcionalidade</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>10.1</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>{{CompatUnknown}}</td>
  </tr>
  <tr>
   <td><code>USVString</code> for constructor <code>init</code> object</td>
   <td>{{CompatVersionUnknown}}</td>
   <td>{{CompatGeckoDesktop("53.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatVersionUnknown}}</td>
   <td>{{CompatUnknown}}</td>
  </tr>
  <tr>
   <td>Record for constructor <code>init</code> object</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatGeckoDesktop("54.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatUnknown}}</td>
  </tr>
 </tbody>
</table>
</div>

<div id="compat-mobile">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Funcionalidade</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 para 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 suport 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>
  <tr>
   <td><code>USVString</code> for constructor <code>init</code> object</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatVersionUnknown}}</td>
   <td>{{CompatGeckoMobile("53.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatVersionUnknown}}</td>
  </tr>
  <tr>
   <td>Record for constructor <code>init</code> object</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatGeckoMobile("54.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatUnknown}}</td>
  </tr>
 </tbody>
</table>
</div>

<h2 id="Ver_também">Ver também</h2>

<ul>
 <li>Outros interfaces relacionados com URL: {{domxref("URL")}}, {{domxref("URLUtils")}}.</li>
 <li><a href="https://developers.google.com/web/updates/2016/01/urlsearchparams?hl=en">Google Developers: Manipulação simples de URL com URLSearchParams</a></li>
</ul>

<dl>
</dl>