aboutsummaryrefslogtreecommitdiff
path: root/files/fr/web/api/urlsearchparams/index.html
blob: d5dd97ba1896db1379a1b27aea74f799ecaac5b2 (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
208
209
210
211
212
213
214
215
216
217
218
219
220
---
title: URLSearchParams
slug: Web/API/URLSearchParams
translation_of: Web/API/URLSearchParams
---
<p>{{ApiRef("URL API")}}</p>

<p>L’interface <strong><code>URLSearchParams</code></strong> définit des méthodes utilitaires pour travailler avec la <em>chaîne de requête</em> (les paramètres <code>GET</code>) d’une URL.</p>

<p>Un objet implémentant <code>URLSearchParams</code> peut être directement utilisé dans une structure {{jsxref("Statements/for...of", "for...of")}}, au lieu de {{domxref('URLSearchParams.entries()', 'entries()')}} : <code>for (var p of mySearchParams)</code> ou son équivalent <code>for (var p of mySearchParams.entries())</code>.</p>

<h2 id="Constructeur">Constructeur</h2>

<dl>
 <dt>{{domxref("URLSearchParams.URLSearchParams", 'URLSearchParams()')}}</dt>
 <dd>Constructeur renvoyant un objet <code>URLSearchParams</code>.</dd>
</dl>

<h2 id="Propriétés">Propriétés</h2>

<p><em>Cette interface n’hérite d’aucune propriété.</em></p>

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

<p><em>Cette interface n’hérite d’aucune méthode.</em></p>

<dl>
 <dt>{{domxref("URLSearchParams.append()")}}</dt>
 <dd>Ajoute une paire clé / valeur spécifiée en tant que nouveau paramètre de recherche.</dd>
 <dt>{{domxref("URLSearchParams.delete()")}}</dt>
 <dd>Supprime le paramètre de recherche donné et sa valeur associée de la liste de tous les paramètres de recherche.</dd>
 <dt>{{domxref("URLSearchParams.entries()")}}</dt>
 <dd>Retourne un {{jsxref("Iteration_protocols","iterator")}} permettant de parcourir toutes les paires clé / valeur contenues dans cet objet.</dd>
 <dt>{{domxref("URLSearchParams.get()")}}</dt>
 <dd>Retourne la première valeur associée au paramètre de recherche donné.</dd>
 <dt>{{domxref("URLSearchParams.getAll()")}}</dt>
 <dd>Retourne toutes les valeurs associées au paramètre de recherche donné.</dd>
 <dt>{{domxref("URLSearchParams.has()")}}</dt>
 <dd>Retourne un {{jsxref("Boolean")}} indiquant si un tel paramètre de recherche existe.</dd>
 <dt>{{domxref("URLSearchParams.keys()")}}</dt>
 <dd>Retourne un {{jsxref("Iteration_protocols", "iterator")}} permettant de parcourir toutes les <strong>clés</strong> des paires clé / valeur contenues dans cet objet.</dd>
 <dt>{{domxref("URLSearchParams.set()")}}</dt>
 <dd>Définit la valeur associée à un paramètre de recherche donné à la valeur donnée. S’il y avait plusieurs valeurs, les autres sont supprimées.</dd>
 <dt>{{domxref("URLSearchParams.sort()")}}</dt>
 <dd>Trie toutes les paires clé / valeur, s’il y en a, par leurs clés.</dd>
 <dt>{{domxref("URLSearchParams.toString()")}}</dt>
 <dd>Retourne une chaîne contenant une chaîne de requête pouvant être utilisée dans une URL.</dd>
 <dt>{{domxref("URLSearchParams.values()")}}</dt>
 <dd>Retourne un {{jsxref("Iteration_protocols", "iterator")}} permettant de parcourir toutes les <strong>valeurs</strong> des paires clé / valeur contenues dans cet objet.</dd>
</dl>

<h2 id="Exemple">Exemple</h2>

<pre class="brush: js">var paramsString = "q=URLUtils.searchParams&amp;topic=api";
var searchParams = new URLSearchParams(paramsString);

// Itère sur les paramètres de recherche.
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="Spécifications">Spécifications</h2>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">Spécification</th>
   <th scope="col">Statut</th>
   <th scope="col">Commentaire</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td>{{SpecName('URL', '#urlsearchparams', "URLSearchParams")}}</td>
   <td>{{Spec2('URL')}}</td>
   <td>Définition initiale.</td>
  </tr>
 </tbody>
</table>

<h2 id="Compatibilité_des_navigateurs">Compatibilité des navigateurs</h2>

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

<div id="compat-desktop">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Fonctionnalité</th>
   <th>Chrome</th>
   <th>Firefox (Gecko)</th>
   <th>Internet Explorer</th>
   <th>Opera</th>
   <th>Safari</th>
  </tr>
  <tr>
   <td>Support de base</td>
   <td>{{CompatChrome(49)}}</td>
   <td>{{CompatGeckoDesktop("29.0")}}<sup>[1]</sup></td>
   <td>{{CompatNo}}</td>
   <td>{{CompatOpera(36)}}</td>
   <td>10.1</td>
  </tr>
  <tr>
   <td><code>entries()</code>, <code>keys()</code>, <code>values()</code>, et support de <code>for...of</code></td>
   <td>{{CompatChrome(49)}}</td>
   <td>{{CompatGeckoDesktop("44.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatOpera(36)}}</td>
   <td>{{CompatUnknown}}</td>
  </tr>
  <tr>
   <td><code>USVString</code> comme argument <code>init</code> du constructeur</td>
   <td>{{CompatChrome(61)}}</td>
   <td>{{CompatGeckoDesktop("53.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatOpera(48)}}</td>
   <td>{{CompatUnknown}}</td>
  </tr>
  <tr>
   <td>Objet littéral comme argument <code>init</code> du constructeur</td>
   <td>{{CompatChrome(61)}}</td>
   <td>{{CompatGeckoDesktop("54.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatOpera(48)}}</td>
   <td>{{CompatUnknown}}</td>
  </tr>
  <tr>
   <td><code>sort()</code></td>
   <td>{{CompatChrome(61)}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatOpera(48)}}</td>
   <td>{{CompatUnknown}}</td>
  </tr>
 </tbody>
</table>
</div>

<div id="compat-mobile">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Fonctionnalité</th>
   <th>Android Webview</th>
   <th>Chrome pour Android</th>
   <th>Firefox Mobile (Gecko)</th>
   <th>IE Mobile</th>
   <th>Opera Mobile</th>
   <th>Safari Mobile</th>
  </tr>
  <tr>
   <td>Support de base</td>
   <td>{{CompatChrome(49)}}</td>
   <td>{{CompatChrome(49)}}</td>
   <td>{{CompatGeckoMobile("29.0")}}<sup>[1]</sup></td>
   <td>{{CompatNo}}</td>
   <td>{{CompatOperaMobile(36)}}</td>
   <td>{{CompatNo}}</td>
  </tr>
  <tr>
   <td><code>entries()</code>, <code>keys()</code>, <code>values()</code>, et support de <code>for...of</code></td>
   <td>{{CompatChrome(49)}}</td>
   <td>{{CompatChrome(49)}}</td>
   <td>{{CompatGeckoMobile("44.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatOperaMobile(36)}}</td>
   <td>{{CompatNo}}</td>
  </tr>
  <tr>
   <td><code>USVString</code> comme argument <code>init</code> du constructeur</td>
   <td>{{CompatChrome(61)}}</td>
   <td>{{CompatChrome(61)}}</td>
   <td>{{CompatGeckoMobile("53.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatOperaMobile(48)}}</td>
   <td>{{CompatUnknown}}</td>
  </tr>
  <tr>
   <td>Objet littéral comme argument <code>init</code> du constructeur</td>
   <td>{{CompatChrome(61)}}</td>
   <td>{{CompatChrome(61)}}</td>
   <td>{{CompatGeckoMobile("54.0")}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatOperaMobile(48)}}</td>
   <td>{{CompatUnknown}}</td>
  </tr>
  <tr>
   <td><code>sort()</code></td>
   <td>{{CompatChrome(61)}}</td>
   <td>{{CompatChrome(61)}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatOperaMobile(48)}}</td>
   <td>{{CompatNo}}</td>
  </tr>
 </tbody>
</table>
</div>

<p>[1] Firefox a un bug qui fait que les guillemets simples contenus dans les URLs sont échappés quand on y accède via les API d’URL ({{bug(1386683)}}). Cela a été corrigé à partir de Firefox 57.</p>

<h2 id="Voir_également">Voir également</h2>

<ul>
 <li>Autres interfaces liées aux 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>