source: frontend/node_modules/qs/test/stringify.js

Last change on this file was 9af201e, checked in by MBK <marija.karapandzova@…>, 12 days ago

Fix frontend appearance

  • Property mode set to 100644
File size: 57.3 KB
Line 
1'use strict';
2
3var test = require('tape');
4var qs = require('../');
5var utils = require('../lib/utils');
6var iconv = require('iconv-lite');
7var SaferBuffer = require('safer-buffer').Buffer;
8var hasSymbols = require('has-symbols');
9var mockProperty = require('mock-property');
10var emptyTestCases = require('./empty-keys-cases').emptyTestCases;
11var hasProto = require('has-proto')();
12var hasBigInt = require('has-bigints')();
13
14test('stringify()', function (t) {
15 t.test('stringifies a querystring object', function (st) {
16 st.equal(qs.stringify({ a: 'b' }), 'a=b');
17 st.equal(qs.stringify({ a: 1 }), 'a=1');
18 st.equal(qs.stringify({ a: 1, b: 2 }), 'a=1&b=2');
19 st.equal(qs.stringify({ a: 'A_Z' }), 'a=A_Z');
20 st.equal(qs.stringify({ a: '€' }), 'a=%E2%82%AC');
21 st.equal(qs.stringify({ a: '' }), 'a=%EE%80%80');
22 st.equal(qs.stringify({ a: 'א' }), 'a=%D7%90');
23 st.equal(qs.stringify({ a: '𐐷' }), 'a=%F0%90%90%B7');
24 st.end();
25 });
26
27 t.test('stringifies falsy values', function (st) {
28 st.equal(qs.stringify(undefined), '');
29 st.equal(qs.stringify(null), '');
30 st.equal(qs.stringify(null, { strictNullHandling: true }), '');
31 st.equal(qs.stringify(false), '');
32 st.equal(qs.stringify(0), '');
33 st.end();
34 });
35
36 t.test('stringifies symbols', { skip: !hasSymbols() }, function (st) {
37 st.equal(qs.stringify(Symbol.iterator), '');
38 st.equal(qs.stringify([Symbol.iterator]), '0=Symbol%28Symbol.iterator%29');
39 st.equal(qs.stringify({ a: Symbol.iterator }), 'a=Symbol%28Symbol.iterator%29');
40 st.equal(
41 qs.stringify({ a: [Symbol.iterator] }, { encodeValuesOnly: true, arrayFormat: 'brackets' }),
42 'a[]=Symbol%28Symbol.iterator%29'
43 );
44 st.end();
45 });
46
47 t.test('stringifies bigints', { skip: !hasBigInt }, function (st) {
48 var three = BigInt(3);
49 var encodeWithN = function (value, defaultEncoder, charset) {
50 var result = defaultEncoder(value, defaultEncoder, charset);
51 return typeof value === 'bigint' ? result + 'n' : result;
52 };
53 st.equal(qs.stringify(three), '');
54 st.equal(qs.stringify([three]), '0=3');
55 st.equal(qs.stringify([three], { encoder: encodeWithN }), '0=3n');
56 st.equal(qs.stringify({ a: three }), 'a=3');
57 st.equal(qs.stringify({ a: three }, { encoder: encodeWithN }), 'a=3n');
58 st.equal(
59 qs.stringify({ a: [three] }, { encodeValuesOnly: true, arrayFormat: 'brackets' }),
60 'a[]=3'
61 );
62 st.equal(
63 qs.stringify({ a: [three] }, { encodeValuesOnly: true, encoder: encodeWithN, arrayFormat: 'brackets' }),
64 'a[]=3n'
65 );
66 st.end();
67 });
68
69 t.test('encodes dot in key of object when encodeDotInKeys and allowDots is provided', function (st) {
70 st.equal(
71 qs.stringify(
72 { 'name.obj': { first: 'John', last: 'Doe' } },
73 { allowDots: false, encodeDotInKeys: false }
74 ),
75 'name.obj%5Bfirst%5D=John&name.obj%5Blast%5D=Doe',
76 'with allowDots false and encodeDotInKeys false'
77 );
78 st.equal(
79 qs.stringify(
80 { 'name.obj': { first: 'John', last: 'Doe' } },
81 { allowDots: true, encodeDotInKeys: false }
82 ),
83 'name.obj.first=John&name.obj.last=Doe',
84 'with allowDots true and encodeDotInKeys false'
85 );
86 st.equal(
87 qs.stringify(
88 { 'name.obj': { first: 'John', last: 'Doe' } },
89 { allowDots: false, encodeDotInKeys: true }
90 ),
91 'name%252Eobj%5Bfirst%5D=John&name%252Eobj%5Blast%5D=Doe',
92 'with allowDots false and encodeDotInKeys true'
93 );
94 st.equal(
95 qs.stringify(
96 { 'name.obj': { first: 'John', last: 'Doe' } },
97 { allowDots: true, encodeDotInKeys: true }
98 ),
99 'name%252Eobj.first=John&name%252Eobj.last=Doe',
100 'with allowDots true and encodeDotInKeys true'
101 );
102
103 st.equal(
104 qs.stringify(
105 { 'name.obj.subobject': { 'first.godly.name': 'John', last: 'Doe' } },
106 { allowDots: false, encodeDotInKeys: false }
107 ),
108 'name.obj.subobject%5Bfirst.godly.name%5D=John&name.obj.subobject%5Blast%5D=Doe',
109 'with allowDots false and encodeDotInKeys false'
110 );
111 st.equal(
112 qs.stringify(
113 { 'name.obj.subobject': { 'first.godly.name': 'John', last: 'Doe' } },
114 { allowDots: true, encodeDotInKeys: false }
115 ),
116 'name.obj.subobject.first.godly.name=John&name.obj.subobject.last=Doe',
117 'with allowDots false and encodeDotInKeys false'
118 );
119 st.equal(
120 qs.stringify(
121 { 'name.obj.subobject': { 'first.godly.name': 'John', last: 'Doe' } },
122 { allowDots: false, encodeDotInKeys: true }
123 ),
124 'name%252Eobj%252Esubobject%5Bfirst.godly.name%5D=John&name%252Eobj%252Esubobject%5Blast%5D=Doe',
125 'with allowDots false and encodeDotInKeys true'
126 );
127 st.equal(
128 qs.stringify(
129 { 'name.obj.subobject': { 'first.godly.name': 'John', last: 'Doe' } },
130 { allowDots: true, encodeDotInKeys: true }
131 ),
132 'name%252Eobj%252Esubobject.first%252Egodly%252Ename=John&name%252Eobj%252Esubobject.last=Doe',
133 'with allowDots true and encodeDotInKeys true'
134 );
135
136 st.end();
137 });
138
139 t.test('should encode dot in key of object, and automatically set allowDots to `true` when encodeDotInKeys is true and allowDots in undefined', function (st) {
140 st.equal(
141 qs.stringify(
142 { 'name.obj.subobject': { 'first.godly.name': 'John', last: 'Doe' } },
143 { encodeDotInKeys: true }
144 ),
145 'name%252Eobj%252Esubobject.first%252Egodly%252Ename=John&name%252Eobj%252Esubobject.last=Doe',
146 'with allowDots undefined and encodeDotInKeys true'
147 );
148 st.end();
149 });
150
151 t.test('should encode dot in key of object when encodeDotInKeys and allowDots is provided, and nothing else when encodeValuesOnly is provided', function (st) {
152 st.equal(
153 qs.stringify({ 'name.obj': { first: 'John', last: 'Doe' } }, {
154 encodeDotInKeys: true, allowDots: true, encodeValuesOnly: true
155 }),
156 'name%2Eobj.first=John&name%2Eobj.last=Doe'
157 );
158
159 st.equal(
160 qs.stringify({ 'name.obj.subobject': { 'first.godly.name': 'John', last: 'Doe' } }, { allowDots: true, encodeDotInKeys: true, encodeValuesOnly: true }),
161 'name%2Eobj%2Esubobject.first%2Egodly%2Ename=John&name%2Eobj%2Esubobject.last=Doe'
162 );
163
164 st.end();
165 });
166
167 t.test('throws when `commaRoundTrip` is not a boolean', function (st) {
168 st['throws'](
169 function () { qs.stringify({}, { commaRoundTrip: 'not a boolean' }); },
170 TypeError,
171 'throws when `commaRoundTrip` is not a boolean'
172 );
173
174 st.end();
175 });
176
177 t.test('throws when `encodeDotInKeys` is not a boolean', function (st) {
178 st['throws'](
179 function () { qs.stringify({ a: [], b: 'zz' }, { encodeDotInKeys: 'foobar' }); },
180 TypeError
181 );
182
183 st['throws'](
184 function () { qs.stringify({ a: [], b: 'zz' }, { encodeDotInKeys: 0 }); },
185 TypeError
186 );
187
188 st['throws'](
189 function () { qs.stringify({ a: [], b: 'zz' }, { encodeDotInKeys: NaN }); },
190 TypeError
191 );
192
193 st['throws'](
194 function () { qs.stringify({ a: [], b: 'zz' }, { encodeDotInKeys: null }); },
195 TypeError
196 );
197
198 st.end();
199 });
200
201 t.test('adds query prefix', function (st) {
202 st.equal(qs.stringify({ a: 'b' }, { addQueryPrefix: true }), '?a=b');
203 st.end();
204 });
205
206 t.test('with query prefix, outputs blank string given an empty object', function (st) {
207 st.equal(qs.stringify({}, { addQueryPrefix: true }), '');
208 st.end();
209 });
210
211 t.test('stringifies nested falsy values', function (st) {
212 st.equal(qs.stringify({ a: { b: { c: null } } }), 'a%5Bb%5D%5Bc%5D=');
213 st.equal(qs.stringify({ a: { b: { c: null } } }, { strictNullHandling: true }), 'a%5Bb%5D%5Bc%5D');
214 st.equal(qs.stringify({ a: { b: { c: false } } }), 'a%5Bb%5D%5Bc%5D=false');
215 st.end();
216 });
217
218 t.test('stringifies a nested object', function (st) {
219 st.equal(qs.stringify({ a: { b: 'c' } }), 'a%5Bb%5D=c');
220 st.equal(qs.stringify({ a: { b: { c: { d: 'e' } } } }), 'a%5Bb%5D%5Bc%5D%5Bd%5D=e');
221 st.end();
222 });
223
224 t.test('`allowDots` option: stringifies a nested object with dots notation', function (st) {
225 st.equal(qs.stringify({ a: { b: 'c' } }, { allowDots: true }), 'a.b=c');
226 st.equal(qs.stringify({ a: { b: { c: { d: 'e' } } } }, { allowDots: true }), 'a.b.c.d=e');
227 st.end();
228 });
229
230 t.test('stringifies an array value', function (st) {
231 st.equal(
232 qs.stringify({ a: ['b', 'c', 'd'] }, { arrayFormat: 'indices' }),
233 'a%5B0%5D=b&a%5B1%5D=c&a%5B2%5D=d',
234 'indices => indices'
235 );
236 st.equal(
237 qs.stringify({ a: ['b', 'c', 'd'] }, { arrayFormat: 'brackets' }),
238 'a%5B%5D=b&a%5B%5D=c&a%5B%5D=d',
239 'brackets => brackets'
240 );
241 st.equal(
242 qs.stringify({ a: ['b', 'c', 'd'] }, { arrayFormat: 'comma' }),
243 'a=b%2Cc%2Cd',
244 'comma => comma'
245 );
246 st.equal(
247 qs.stringify({ a: ['b', 'c', 'd'] }, { arrayFormat: 'comma', commaRoundTrip: true }),
248 'a=b%2Cc%2Cd',
249 'comma round trip => comma'
250 );
251 st.equal(
252 qs.stringify({ a: ['b', 'c', 'd'] }),
253 'a%5B0%5D=b&a%5B1%5D=c&a%5B2%5D=d',
254 'default => indices'
255 );
256 st.end();
257 });
258
259 t.test('`skipNulls` option', function (st) {
260 st.equal(
261 qs.stringify({ a: 'b', c: null }, { skipNulls: true }),
262 'a=b',
263 'omits nulls when asked'
264 );
265
266 st.equal(
267 qs.stringify({ a: { b: 'c', d: null } }, { skipNulls: true }),
268 'a%5Bb%5D=c',
269 'omits nested nulls when asked'
270 );
271
272 st.end();
273 });
274
275 t.test('omits array indices when asked', function (st) {
276 st.equal(qs.stringify({ a: ['b', 'c', 'd'] }, { indices: false }), 'a=b&a=c&a=d');
277
278 st.end();
279 });
280
281 t.test('omits object key/value pair when value is empty array', function (st) {
282 st.equal(qs.stringify({ a: [], b: 'zz' }), 'b=zz');
283
284 st.end();
285 });
286
287 t.test('should not omit object key/value pair when value is empty array and when asked', function (st) {
288 st.equal(qs.stringify({ a: [], b: 'zz' }), 'b=zz');
289 st.equal(qs.stringify({ a: [], b: 'zz' }, { allowEmptyArrays: false }), 'b=zz');
290 st.equal(qs.stringify({ a: [], b: 'zz' }, { allowEmptyArrays: true }), 'a[]&b=zz');
291
292 st.end();
293 });
294
295 t.test('should throw when allowEmptyArrays is not of type boolean', function (st) {
296 st['throws'](
297 function () { qs.stringify({ a: [], b: 'zz' }, { allowEmptyArrays: 'foobar' }); },
298 TypeError
299 );
300
301 st['throws'](
302 function () { qs.stringify({ a: [], b: 'zz' }, { allowEmptyArrays: 0 }); },
303 TypeError
304 );
305
306 st['throws'](
307 function () { qs.stringify({ a: [], b: 'zz' }, { allowEmptyArrays: NaN }); },
308 TypeError
309 );
310
311 st['throws'](
312 function () { qs.stringify({ a: [], b: 'zz' }, { allowEmptyArrays: null }); },
313 TypeError
314 );
315
316 st.end();
317 });
318
319 t.test('allowEmptyArrays + strictNullHandling', function (st) {
320 st.equal(
321 qs.stringify(
322 { testEmptyArray: [] },
323 { strictNullHandling: true, allowEmptyArrays: true }
324 ),
325 'testEmptyArray[]'
326 );
327
328 st.end();
329 });
330
331 t.test('stringifies an array value with one item vs multiple items', function (st) {
332 st.test('non-array item', function (s2t) {
333 s2t.equal(qs.stringify({ a: 'c' }, { encodeValuesOnly: true, arrayFormat: 'indices' }), 'a=c');
334 s2t.equal(qs.stringify({ a: 'c' }, { encodeValuesOnly: true, arrayFormat: 'brackets' }), 'a=c');
335 s2t.equal(qs.stringify({ a: 'c' }, { encodeValuesOnly: true, arrayFormat: 'comma' }), 'a=c');
336 s2t.equal(qs.stringify({ a: 'c' }, { encodeValuesOnly: true }), 'a=c');
337
338 s2t.end();
339 });
340
341 st.test('array with a single item', function (s2t) {
342 s2t.equal(qs.stringify({ a: ['c'] }, { encodeValuesOnly: true, arrayFormat: 'indices' }), 'a[0]=c');
343 s2t.equal(qs.stringify({ a: ['c'] }, { encodeValuesOnly: true, arrayFormat: 'brackets' }), 'a[]=c');
344 s2t.equal(qs.stringify({ a: ['c'] }, { encodeValuesOnly: true, arrayFormat: 'comma' }), 'a=c');
345 s2t.equal(qs.stringify({ a: ['c'] }, { encodeValuesOnly: true, arrayFormat: 'comma', commaRoundTrip: true }), 'a[]=c'); // so it parses back as an array
346 s2t.equal(qs.stringify({ a: ['c'] }, { encodeValuesOnly: true }), 'a[0]=c');
347
348 s2t.end();
349 });
350
351 st.test('array with multiple items', function (s2t) {
352 s2t.equal(qs.stringify({ a: ['c', 'd'] }, { encodeValuesOnly: true, arrayFormat: 'indices' }), 'a[0]=c&a[1]=d');
353 s2t.equal(qs.stringify({ a: ['c', 'd'] }, { encodeValuesOnly: true, arrayFormat: 'brackets' }), 'a[]=c&a[]=d');
354 s2t.equal(qs.stringify({ a: ['c', 'd'] }, { encodeValuesOnly: true, arrayFormat: 'comma' }), 'a=c,d');
355 s2t.equal(qs.stringify({ a: ['c', 'd'] }, { encodeValuesOnly: true, arrayFormat: 'comma', commaRoundTrip: true }), 'a=c,d');
356 s2t.equal(qs.stringify({ a: ['c', 'd'] }, { encodeValuesOnly: true }), 'a[0]=c&a[1]=d');
357
358 s2t.end();
359 });
360
361 st.test('array with multiple items with a comma inside', function (s2t) {
362 s2t.equal(qs.stringify({ a: ['c,d', 'e'] }, { encodeValuesOnly: true, arrayFormat: 'comma' }), 'a=c%2Cd,e');
363 s2t.equal(qs.stringify({ a: ['c,d', 'e'] }, { arrayFormat: 'comma' }), 'a=c%2Cd%2Ce');
364
365 s2t.equal(qs.stringify({ a: ['c,d', 'e'] }, { encodeValuesOnly: true, arrayFormat: 'comma', commaRoundTrip: true }), 'a=c%2Cd,e');
366 s2t.equal(qs.stringify({ a: ['c,d', 'e'] }, { arrayFormat: 'comma', commaRoundTrip: true }), 'a=c%2Cd%2Ce');
367
368 s2t.end();
369 });
370
371 st.end();
372 });
373
374 t.test('stringifies a nested array value', function (st) {
375 st.equal(qs.stringify({ a: { b: ['c', 'd'] } }, { encodeValuesOnly: true, arrayFormat: 'indices' }), 'a[b][0]=c&a[b][1]=d');
376 st.equal(qs.stringify({ a: { b: ['c', 'd'] } }, { encodeValuesOnly: true, arrayFormat: 'brackets' }), 'a[b][]=c&a[b][]=d');
377 st.equal(qs.stringify({ a: { b: ['c', 'd'] } }, { encodeValuesOnly: true, arrayFormat: 'comma' }), 'a[b]=c,d');
378 st.equal(qs.stringify({ a: { b: ['c', 'd'] } }, { encodeValuesOnly: true }), 'a[b][0]=c&a[b][1]=d');
379 st.end();
380 });
381
382 t.test('stringifies comma and empty array values', function (st) {
383 st.equal(qs.stringify({ a: [',', '', 'c,d%'] }, { encode: false, arrayFormat: 'indices' }), 'a[0]=,&a[1]=&a[2]=c,d%');
384 st.equal(qs.stringify({ a: [',', '', 'c,d%'] }, { encode: false, arrayFormat: 'brackets' }), 'a[]=,&a[]=&a[]=c,d%');
385 st.equal(qs.stringify({ a: [',', '', 'c,d%'] }, { encode: false, arrayFormat: 'comma' }), 'a=,,,c,d%');
386 st.equal(qs.stringify({ a: [',', '', 'c,d%'] }, { encode: false, arrayFormat: 'repeat' }), 'a=,&a=&a=c,d%');
387
388 st.equal(qs.stringify({ a: [',', '', 'c,d%'] }, { encode: true, encodeValuesOnly: true, arrayFormat: 'indices' }), 'a[0]=%2C&a[1]=&a[2]=c%2Cd%25');
389 st.equal(qs.stringify({ a: [',', '', 'c,d%'] }, { encode: true, encodeValuesOnly: true, arrayFormat: 'brackets' }), 'a[]=%2C&a[]=&a[]=c%2Cd%25');
390 st.equal(qs.stringify({ a: [',', '', 'c,d%'] }, { encode: true, encodeValuesOnly: true, arrayFormat: 'comma' }), 'a=%2C,,c%2Cd%25');
391 st.equal(qs.stringify({ a: [',', '', 'c,d%'] }, { encode: true, encodeValuesOnly: true, arrayFormat: 'repeat' }), 'a=%2C&a=&a=c%2Cd%25');
392
393 st.equal(qs.stringify({ a: [',', '', 'c,d%'] }, { encode: true, encodeValuesOnly: false, arrayFormat: 'indices' }), 'a%5B0%5D=%2C&a%5B1%5D=&a%5B2%5D=c%2Cd%25');
394 st.equal(qs.stringify({ a: [',', '', 'c,d%'] }, { encode: true, encodeValuesOnly: false, arrayFormat: 'brackets' }), 'a%5B%5D=%2C&a%5B%5D=&a%5B%5D=c%2Cd%25');
395 st.equal(qs.stringify({ a: [',', '', 'c,d%'] }, { encode: true, encodeValuesOnly: false, arrayFormat: 'comma' }), 'a=%2C%2C%2Cc%2Cd%25');
396 st.equal(qs.stringify({ a: [',', '', 'c,d%'] }, { encode: true, encodeValuesOnly: false, arrayFormat: 'repeat' }), 'a=%2C&a=&a=c%2Cd%25');
397
398 st.end();
399 });
400
401 t.test('stringifies comma and empty non-array values', function (st) {
402 st.equal(qs.stringify({ a: ',', b: '', c: 'c,d%' }, { encode: false, arrayFormat: 'indices' }), 'a=,&b=&c=c,d%');
403 st.equal(qs.stringify({ a: ',', b: '', c: 'c,d%' }, { encode: false, arrayFormat: 'brackets' }), 'a=,&b=&c=c,d%');
404 st.equal(qs.stringify({ a: ',', b: '', c: 'c,d%' }, { encode: false, arrayFormat: 'comma' }), 'a=,&b=&c=c,d%');
405 st.equal(qs.stringify({ a: ',', b: '', c: 'c,d%' }, { encode: false, arrayFormat: 'repeat' }), 'a=,&b=&c=c,d%');
406
407 st.equal(qs.stringify({ a: ',', b: '', c: 'c,d%' }, { encode: true, encodeValuesOnly: true, arrayFormat: 'indices' }), 'a=%2C&b=&c=c%2Cd%25');
408 st.equal(qs.stringify({ a: ',', b: '', c: 'c,d%' }, { encode: true, encodeValuesOnly: true, arrayFormat: 'brackets' }), 'a=%2C&b=&c=c%2Cd%25');
409 st.equal(qs.stringify({ a: ',', b: '', c: 'c,d%' }, { encode: true, encodeValuesOnly: true, arrayFormat: 'comma' }), 'a=%2C&b=&c=c%2Cd%25');
410 st.equal(qs.stringify({ a: ',', b: '', c: 'c,d%' }, { encode: true, encodeValuesOnly: true, arrayFormat: 'repeat' }), 'a=%2C&b=&c=c%2Cd%25');
411
412 st.equal(qs.stringify({ a: ',', b: '', c: 'c,d%' }, { encode: true, encodeValuesOnly: false, arrayFormat: 'indices' }), 'a=%2C&b=&c=c%2Cd%25');
413 st.equal(qs.stringify({ a: ',', b: '', c: 'c,d%' }, { encode: true, encodeValuesOnly: false, arrayFormat: 'brackets' }), 'a=%2C&b=&c=c%2Cd%25');
414 st.equal(qs.stringify({ a: ',', b: '', c: 'c,d%' }, { encode: true, encodeValuesOnly: false, arrayFormat: 'comma' }), 'a=%2C&b=&c=c%2Cd%25');
415 st.equal(qs.stringify({ a: ',', b: '', c: 'c,d%' }, { encode: true, encodeValuesOnly: false, arrayFormat: 'repeat' }), 'a=%2C&b=&c=c%2Cd%25');
416
417 st.end();
418 });
419
420 t.test('stringifies a nested array value with dots notation', function (st) {
421 st.equal(
422 qs.stringify(
423 { a: { b: ['c', 'd'] } },
424 { allowDots: true, encodeValuesOnly: true, arrayFormat: 'indices' }
425 ),
426 'a.b[0]=c&a.b[1]=d',
427 'indices: stringifies with dots + indices'
428 );
429 st.equal(
430 qs.stringify(
431 { a: { b: ['c', 'd'] } },
432 { allowDots: true, encodeValuesOnly: true, arrayFormat: 'brackets' }
433 ),
434 'a.b[]=c&a.b[]=d',
435 'brackets: stringifies with dots + brackets'
436 );
437 st.equal(
438 qs.stringify(
439 { a: { b: ['c', 'd'] } },
440 { allowDots: true, encodeValuesOnly: true, arrayFormat: 'comma' }
441 ),
442 'a.b=c,d',
443 'comma: stringifies with dots + comma'
444 );
445 st.equal(
446 qs.stringify(
447 { a: { b: ['c', 'd'] } },
448 { allowDots: true, encodeValuesOnly: true }
449 ),
450 'a.b[0]=c&a.b[1]=d',
451 'default: stringifies with dots + indices'
452 );
453 st.end();
454 });
455
456 t.test('stringifies an object inside an array', function (st) {
457 st.equal(
458 qs.stringify({ a: [{ b: 'c' }] }, { arrayFormat: 'indices', encodeValuesOnly: true }),
459 'a[0][b]=c',
460 'indices => indices'
461 );
462 st.equal(
463 qs.stringify({ a: [{ b: 'c' }] }, { arrayFormat: 'repeat', encodeValuesOnly: true }),
464 'a[b]=c',
465 'repeat => repeat'
466 );
467 st.equal(
468 qs.stringify({ a: [{ b: 'c' }] }, { arrayFormat: 'brackets', encodeValuesOnly: true }),
469 'a[][b]=c',
470 'brackets => brackets'
471 );
472 st.equal(
473 qs.stringify({ a: [{ b: 'c' }] }, { encodeValuesOnly: true }),
474 'a[0][b]=c',
475 'default => indices'
476 );
477
478 st.equal(
479 qs.stringify({ a: [{ b: { c: [1] } }] }, { arrayFormat: 'indices', encodeValuesOnly: true }),
480 'a[0][b][c][0]=1',
481 'indices => indices'
482 );
483 st.equal(
484 qs.stringify({ a: [{ b: { c: [1] } }] }, { arrayFormat: 'repeat', encodeValuesOnly: true }),
485 'a[b][c]=1',
486 'repeat => repeat'
487 );
488 st.equal(
489 qs.stringify({ a: [{ b: { c: [1] } }] }, { arrayFormat: 'brackets', encodeValuesOnly: true }),
490 'a[][b][c][]=1',
491 'brackets => brackets'
492 );
493 st.equal(
494 qs.stringify({ a: [{ b: { c: [1] } }] }, { encodeValuesOnly: true }),
495 'a[0][b][c][0]=1',
496 'default => indices'
497 );
498
499 st.end();
500 });
501
502 t.test('stringifies an array with mixed objects and primitives', function (st) {
503 st.equal(
504 qs.stringify({ a: [{ b: 1 }, 2, 3] }, { encodeValuesOnly: true, arrayFormat: 'indices' }),
505 'a[0][b]=1&a[1]=2&a[2]=3',
506 'indices => indices'
507 );
508 st.equal(
509 qs.stringify({ a: [{ b: 1 }, 2, 3] }, { encodeValuesOnly: true, arrayFormat: 'brackets' }),
510 'a[][b]=1&a[]=2&a[]=3',
511 'brackets => brackets'
512 );
513 st.equal(
514 qs.stringify({ a: [{ b: 1 }, 2, 3] }, { encodeValuesOnly: true, arrayFormat: 'comma' }),
515 '???',
516 'brackets => brackets',
517 { skip: 'TODO: figure out what this should do' }
518 );
519 st.equal(
520 qs.stringify({ a: [{ b: 1 }, 2, 3] }, { encodeValuesOnly: true }),
521 'a[0][b]=1&a[1]=2&a[2]=3',
522 'default => indices'
523 );
524
525 st.end();
526 });
527
528 t.test('stringifies an object inside an array with dots notation', function (st) {
529 st.equal(
530 qs.stringify(
531 { a: [{ b: 'c' }] },
532 { allowDots: true, encode: false, arrayFormat: 'indices' }
533 ),
534 'a[0].b=c',
535 'indices => indices'
536 );
537 st.equal(
538 qs.stringify(
539 { a: [{ b: 'c' }] },
540 { allowDots: true, encode: false, arrayFormat: 'brackets' }
541 ),
542 'a[].b=c',
543 'brackets => brackets'
544 );
545 st.equal(
546 qs.stringify(
547 { a: [{ b: 'c' }] },
548 { allowDots: true, encode: false }
549 ),
550 'a[0].b=c',
551 'default => indices'
552 );
553
554 st.equal(
555 qs.stringify(
556 { a: [{ b: { c: [1] } }] },
557 { allowDots: true, encode: false, arrayFormat: 'indices' }
558 ),
559 'a[0].b.c[0]=1',
560 'indices => indices'
561 );
562 st.equal(
563 qs.stringify(
564 { a: [{ b: { c: [1] } }] },
565 { allowDots: true, encode: false, arrayFormat: 'brackets' }
566 ),
567 'a[].b.c[]=1',
568 'brackets => brackets'
569 );
570 st.equal(
571 qs.stringify(
572 { a: [{ b: { c: [1] } }] },
573 { allowDots: true, encode: false }
574 ),
575 'a[0].b.c[0]=1',
576 'default => indices'
577 );
578
579 st.end();
580 });
581
582 t.test('does not omit object keys when indices = false', function (st) {
583 st.equal(qs.stringify({ a: [{ b: 'c' }] }, { indices: false }), 'a%5Bb%5D=c');
584 st.end();
585 });
586
587 t.test('uses indices notation for arrays when indices=true', function (st) {
588 st.equal(qs.stringify({ a: ['b', 'c'] }, { indices: true }), 'a%5B0%5D=b&a%5B1%5D=c');
589 st.end();
590 });
591
592 t.test('uses indices notation for arrays when no arrayFormat is specified', function (st) {
593 st.equal(qs.stringify({ a: ['b', 'c'] }), 'a%5B0%5D=b&a%5B1%5D=c');
594 st.end();
595 });
596
597 t.test('uses indices notation for arrays when arrayFormat=indices', function (st) {
598 st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'indices' }), 'a%5B0%5D=b&a%5B1%5D=c');
599 st.end();
600 });
601
602 t.test('uses repeat notation for arrays when arrayFormat=repeat', function (st) {
603 st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'repeat' }), 'a=b&a=c');
604 st.end();
605 });
606
607 t.test('uses brackets notation for arrays when arrayFormat=brackets', function (st) {
608 st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'brackets' }), 'a%5B%5D=b&a%5B%5D=c');
609 st.end();
610 });
611
612 t.test('stringifies a complicated object', function (st) {
613 st.equal(qs.stringify({ a: { b: 'c', d: 'e' } }), 'a%5Bb%5D=c&a%5Bd%5D=e');
614 st.end();
615 });
616
617 t.test('stringifies an empty value', function (st) {
618 st.equal(qs.stringify({ a: '' }), 'a=');
619 st.equal(qs.stringify({ a: null }, { strictNullHandling: true }), 'a');
620
621 st.equal(qs.stringify({ a: '', b: '' }), 'a=&b=');
622 st.equal(qs.stringify({ a: null, b: '' }, { strictNullHandling: true }), 'a&b=');
623
624 st.equal(qs.stringify({ a: { b: '' } }), 'a%5Bb%5D=');
625 st.equal(qs.stringify({ a: { b: null } }, { strictNullHandling: true }), 'a%5Bb%5D');
626 st.equal(qs.stringify({ a: { b: null } }, { strictNullHandling: false }), 'a%5Bb%5D=');
627
628 st.end();
629 });
630
631 t.test('stringifies an empty array in different arrayFormat', function (st) {
632 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false }), 'b[0]=&c=c');
633 // arrayFormat default
634 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'indices' }), 'b[0]=&c=c');
635 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'brackets' }), 'b[]=&c=c');
636 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'repeat' }), 'b=&c=c');
637 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'comma' }), 'b=&c=c');
638 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'comma', commaRoundTrip: true }), 'b[]=&c=c');
639 // with strictNullHandling
640 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'indices', strictNullHandling: true }), 'b[0]&c=c');
641 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'brackets', strictNullHandling: true }), 'b[]&c=c');
642 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'repeat', strictNullHandling: true }), 'b&c=c');
643 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'comma', strictNullHandling: true }), 'b&c=c');
644 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'comma', strictNullHandling: true, commaRoundTrip: true }), 'b[]&c=c');
645 // with skipNulls
646 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'indices', skipNulls: true }), 'c=c');
647 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'brackets', skipNulls: true }), 'c=c');
648 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'repeat', skipNulls: true }), 'c=c');
649 st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'comma', skipNulls: true }), 'c=c');
650
651 st.end();
652 });
653
654 t.test('does not crash on null/undefined entries in arrayFormat=comma with encodeValuesOnly', function (st) {
655 st.doesNotThrow(
656 function () { qs.stringify({ a: [null, 'b'] }, { arrayFormat: 'comma', encodeValuesOnly: true }); },
657 'does not pass a raw null array entry to the encoder'
658 );
659 st.doesNotThrow(
660 function () { qs.stringify({ a: [undefined, 'b'] }, { arrayFormat: 'comma', encodeValuesOnly: true }); },
661 'does not pass a raw undefined array entry to the encoder'
662 );
663 st.doesNotThrow(
664 function () { qs.stringify({ a: [null] }, { arrayFormat: 'comma', encodeValuesOnly: true }); },
665 'does not crash on a single-null array'
666 );
667
668 st.equal(
669 qs.stringify({ a: [null, 'b'] }, { arrayFormat: 'comma', encodeValuesOnly: true }),
670 'a=,b',
671 'null entry joins as empty, comma stays unencoded under encodeValuesOnly'
672 );
673 st.equal(
674 qs.stringify({ a: [undefined, 'b'] }, { arrayFormat: 'comma', encodeValuesOnly: true }),
675 'a=,b',
676 'undefined entry joins as empty, comma stays unencoded under encodeValuesOnly'
677 );
678 st.equal(
679 qs.stringify({ a: [null] }, { arrayFormat: 'comma', encodeValuesOnly: true }),
680 'a=',
681 'single-null array stringifies as empty value'
682 );
683 st.equal(
684 qs.stringify({ a: [null] }, { arrayFormat: 'comma', encodeValuesOnly: true, strictNullHandling: true }),
685 'a',
686 'strictNullHandling drops the equals sign for a single-null array'
687 );
688 st.equal(
689 qs.stringify({ a: [null] }, { arrayFormat: 'comma', encodeValuesOnly: true, skipNulls: true }),
690 '',
691 'skipNulls drops a single-null array entirely'
692 );
693
694 st.end();
695 });
696
697 t.test('stringifies a null object', { skip: !hasProto }, function (st) {
698 st.equal(qs.stringify({ __proto__: null, a: 'b' }), 'a=b');
699 st.end();
700 });
701
702 t.test('returns an empty string for invalid input', function (st) {
703 st.equal(qs.stringify(undefined), '');
704 st.equal(qs.stringify(false), '');
705 st.equal(qs.stringify(null), '');
706 st.equal(qs.stringify(''), '');
707 st.end();
708 });
709
710 t.test('stringifies an object with a null object as a child', { skip: !hasProto }, function (st) {
711 st.equal(qs.stringify({ a: { __proto__: null, b: 'c' } }), 'a%5Bb%5D=c');
712 st.end();
713 });
714
715 t.test('drops keys with a value of undefined', function (st) {
716 st.equal(qs.stringify({ a: undefined }), '');
717
718 st.equal(qs.stringify({ a: { b: undefined, c: null } }, { strictNullHandling: true }), 'a%5Bc%5D');
719 st.equal(qs.stringify({ a: { b: undefined, c: null } }, { strictNullHandling: false }), 'a%5Bc%5D=');
720 st.equal(qs.stringify({ a: { b: undefined, c: '' } }), 'a%5Bc%5D=');
721 st.end();
722 });
723
724 t.test('url encodes values', function (st) {
725 st.equal(qs.stringify({ a: 'b c' }), 'a=b%20c');
726 st.end();
727 });
728
729 t.test('stringifies a date', function (st) {
730 var now = new Date();
731 var str = 'a=' + encodeURIComponent(now.toISOString());
732 st.equal(qs.stringify({ a: now }), str);
733 st.end();
734 });
735
736 t.test('stringifies the weird object from qs', function (st) {
737 st.equal(qs.stringify({ 'my weird field': '~q1!2"\'w$5&7/z8)?' }), 'my%20weird%20field=~q1%212%22%27w%245%267%2Fz8%29%3F');
738 st.end();
739 });
740
741 t.test('skips properties that are part of the object prototype', function (st) {
742 st.intercept(Object.prototype, 'crash', { value: 'test' });
743
744 st.equal(qs.stringify({ a: 'b' }), 'a=b');
745 st.equal(qs.stringify({ a: { b: 'c' } }), 'a%5Bb%5D=c');
746
747 st.end();
748 });
749
750 t.test('stringifies boolean values', function (st) {
751 st.equal(qs.stringify({ a: true }), 'a=true');
752 st.equal(qs.stringify({ a: { b: true } }), 'a%5Bb%5D=true');
753 st.equal(qs.stringify({ b: false }), 'b=false');
754 st.equal(qs.stringify({ b: { c: false } }), 'b%5Bc%5D=false');
755 st.end();
756 });
757
758 t.test('stringifies buffer values', function (st) {
759 st.equal(qs.stringify({ a: SaferBuffer.from('test') }), 'a=test');
760 st.equal(qs.stringify({ a: { b: SaferBuffer.from('test') } }), 'a%5Bb%5D=test');
761 st.end();
762 });
763
764 t.test('stringifies an object using an alternative delimiter', function (st) {
765 st.equal(qs.stringify({ a: 'b', c: 'd' }, { delimiter: ';' }), 'a=b;c=d');
766 st.end();
767 });
768
769 t.test('does not blow up when Buffer global is missing', function (st) {
770 var restore = mockProperty(global, 'Buffer', { 'delete': true });
771
772 var result = qs.stringify({ a: 'b', c: 'd' });
773
774 restore();
775
776 st.equal(result, 'a=b&c=d');
777 st.end();
778 });
779
780 t.test('does not crash when parsing circular references', function (st) {
781 var a = {};
782 a.b = a;
783
784 st['throws'](
785 function () { qs.stringify({ 'foo[bar]': 'baz', 'foo[baz]': a }); },
786 /RangeError: Cyclic object value/,
787 'cyclic values throw'
788 );
789
790 var circular = {
791 a: 'value'
792 };
793 circular.a = circular;
794 st['throws'](
795 function () { qs.stringify(circular); },
796 /RangeError: Cyclic object value/,
797 'cyclic values throw'
798 );
799
800 var arr = ['a'];
801 st.doesNotThrow(
802 function () { qs.stringify({ x: arr, y: arr }); },
803 'non-cyclic values do not throw'
804 );
805
806 st.end();
807 });
808
809 t.test('non-circular duplicated references can still work', function (st) {
810 var hourOfDay = {
811 'function': 'hour_of_day'
812 };
813
814 var p1 = {
815 'function': 'gte',
816 arguments: [hourOfDay, 0]
817 };
818 var p2 = {
819 'function': 'lte',
820 arguments: [hourOfDay, 23]
821 };
822
823 st.equal(
824 qs.stringify({ filters: { $and: [p1, p2] } }, { encodeValuesOnly: true, arrayFormat: 'indices' }),
825 'filters[$and][0][function]=gte&filters[$and][0][arguments][0][function]=hour_of_day&filters[$and][0][arguments][1]=0&filters[$and][1][function]=lte&filters[$and][1][arguments][0][function]=hour_of_day&filters[$and][1][arguments][1]=23'
826 );
827 st.equal(
828 qs.stringify({ filters: { $and: [p1, p2] } }, { encodeValuesOnly: true, arrayFormat: 'brackets' }),
829 'filters[$and][][function]=gte&filters[$and][][arguments][][function]=hour_of_day&filters[$and][][arguments][]=0&filters[$and][][function]=lte&filters[$and][][arguments][][function]=hour_of_day&filters[$and][][arguments][]=23'
830 );
831 st.equal(
832 qs.stringify({ filters: { $and: [p1, p2] } }, { encodeValuesOnly: true, arrayFormat: 'repeat' }),
833 'filters[$and][function]=gte&filters[$and][arguments][function]=hour_of_day&filters[$and][arguments]=0&filters[$and][function]=lte&filters[$and][arguments][function]=hour_of_day&filters[$and][arguments]=23'
834 );
835
836 st.end();
837 });
838
839 t.test('selects properties when filter=array', function (st) {
840 st.equal(qs.stringify({ a: 'b' }, { filter: ['a'] }), 'a=b');
841 st.equal(qs.stringify({ a: 1 }, { filter: [] }), '');
842
843 st.equal(
844 qs.stringify(
845 { a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' },
846 { filter: ['a', 'b', 0, 2], arrayFormat: 'indices' }
847 ),
848 'a%5Bb%5D%5B0%5D=1&a%5Bb%5D%5B2%5D=3',
849 'indices => indices'
850 );
851 st.equal(
852 qs.stringify(
853 { a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' },
854 { filter: ['a', 'b', 0, 2], arrayFormat: 'brackets' }
855 ),
856 'a%5Bb%5D%5B%5D=1&a%5Bb%5D%5B%5D=3',
857 'brackets => brackets'
858 );
859 st.equal(
860 qs.stringify(
861 { a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' },
862 { filter: ['a', 'b', 0, 2] }
863 ),
864 'a%5Bb%5D%5B0%5D=1&a%5Bb%5D%5B2%5D=3',
865 'default => indices'
866 );
867
868 st.end();
869 });
870
871 t.test('skips null/undefined entries in filter=array', function (st) {
872 st.doesNotThrow(
873 function () { qs.stringify({ a: 'b', undefined: 'x' }, { filter: ['a', undefined] }); },
874 'does not pass a raw undefined filter entry to the encoder'
875 );
876 st.doesNotThrow(
877 function () { qs.stringify({ a: 'b', 'null': 'x' }, { filter: ['a', null] }); },
878 'does not pass a raw null filter entry to the encoder'
879 );
880
881 st.equal(
882 qs.stringify({ a: 'b', undefined: 'x', c: 'd' }, { filter: ['a', undefined, 'c'] }),
883 'a=b&c=d',
884 'undefined filter entry is skipped, remaining keys are kept'
885 );
886 st.equal(
887 qs.stringify({ a: 'b', 'null': 'x', c: 'd' }, { filter: ['a', null, 'c'] }),
888 'a=b&c=d',
889 'null filter entry is skipped, remaining keys are kept'
890 );
891 st.equal(
892 qs.stringify({ a: 'b', 'null': 'x' }, { filter: [null] }),
893 '',
894 'filter array containing only null yields empty string'
895 );
896
897 st.end();
898 });
899
900 t.test('supports custom representations when filter=function', function (st) {
901 var calls = 0;
902 var obj = { a: 'b', c: 'd', e: { f: new Date(1257894000000) } };
903 var filterFunc = function (prefix, value) {
904 calls += 1;
905 if (calls === 1) {
906 st.equal(prefix, '', 'prefix is empty');
907 st.equal(value, obj);
908 } else if (prefix === 'c') {
909 return void 0;
910 } else if (value instanceof Date) {
911 st.equal(prefix, 'e[f]');
912 return value.getTime();
913 }
914 return value;
915 };
916
917 st.equal(qs.stringify(obj, { filter: filterFunc }), 'a=b&e%5Bf%5D=1257894000000');
918 st.equal(calls, 5);
919 st.end();
920 });
921
922 t.test('can disable uri encoding', function (st) {
923 st.equal(qs.stringify({ a: 'b' }, { encode: false }), 'a=b');
924 st.equal(qs.stringify({ a: { b: 'c' } }, { encode: false }), 'a[b]=c');
925 st.equal(qs.stringify({ a: 'b', c: null }, { strictNullHandling: true, encode: false }), 'a=b&c');
926 st.end();
927 });
928
929 t.test('can sort the keys', function (st) {
930 var sort = function (a, b) {
931 return a.localeCompare(b);
932 };
933 st.equal(qs.stringify({ a: 'c', z: 'y', b: 'f' }, { sort: sort }), 'a=c&b=f&z=y');
934 st.equal(qs.stringify({ a: 'c', z: { j: 'a', i: 'b' }, b: 'f' }, { sort: sort }), 'a=c&b=f&z%5Bi%5D=b&z%5Bj%5D=a');
935 st.end();
936 });
937
938 t.test('can sort the keys at depth 3 or more too', function (st) {
939 var sort = function (a, b) {
940 return a.localeCompare(b);
941 };
942 st.equal(
943 qs.stringify(
944 { a: 'a', z: { zj: { zjb: 'zjb', zja: 'zja' }, zi: { zib: 'zib', zia: 'zia' } }, b: 'b' },
945 { sort: sort, encode: false }
946 ),
947 'a=a&b=b&z[zi][zia]=zia&z[zi][zib]=zib&z[zj][zja]=zja&z[zj][zjb]=zjb'
948 );
949 st.equal(
950 qs.stringify(
951 { a: 'a', z: { zj: { zjb: 'zjb', zja: 'zja' }, zi: { zib: 'zib', zia: 'zia' } }, b: 'b' },
952 { sort: null, encode: false }
953 ),
954 'a=a&z[zj][zjb]=zjb&z[zj][zja]=zja&z[zi][zib]=zib&z[zi][zia]=zia&b=b'
955 );
956 st.end();
957 });
958
959 t.test('can stringify with custom encoding', function (st) {
960 st.equal(qs.stringify({ 県: '大阪府', '': '' }, {
961 encoder: function (str) {
962 if (str.length === 0) {
963 return '';
964 }
965 var buf = iconv.encode(str, 'shiftjis');
966 var result = [];
967 for (var i = 0; i < buf.length; ++i) {
968 result.push(buf.readUInt8(i).toString(16));
969 }
970 return '%' + result.join('%');
971 }
972 }), '%8c%a7=%91%e5%8d%e3%95%7b&=');
973 st.end();
974 });
975
976 t.test('receives the default encoder as a second argument', function (st) {
977 st.plan(8);
978
979 qs.stringify({ a: 1, b: new Date(), c: true, d: [1] }, {
980 encoder: function (str) {
981 st.match(typeof str, /^(?:string|number|boolean)$/);
982 return '';
983 }
984 });
985
986 st.end();
987 });
988
989 t.test('receives the default encoder as a second argument', function (st) {
990 st.plan(2);
991
992 qs.stringify({ a: 1 }, {
993 encoder: function (str, defaultEncoder) {
994 st.equal(defaultEncoder, utils.encode);
995 }
996 });
997
998 st.end();
999 });
1000
1001 t.test('throws error with wrong encoder', function (st) {
1002 st['throws'](function () {
1003 qs.stringify({}, { encoder: 'string' });
1004 }, new TypeError('Encoder has to be a function.'));
1005 st.end();
1006 });
1007
1008 t.test('can use custom encoder for a buffer object', { skip: typeof Buffer === 'undefined' }, function (st) {
1009 st.equal(qs.stringify({ a: SaferBuffer.from([1]) }, {
1010 encoder: function (buffer) {
1011 if (typeof buffer === 'string') {
1012 return buffer;
1013 }
1014 return String.fromCharCode(buffer.readUInt8(0) + 97);
1015 }
1016 }), 'a=b');
1017
1018 st.equal(qs.stringify({ a: SaferBuffer.from('a b') }, {
1019 encoder: function (buffer) {
1020 return buffer;
1021 }
1022 }), 'a=a b');
1023 st.end();
1024 });
1025
1026 t.test('serializeDate option', function (st) {
1027 var date = new Date();
1028 st.equal(
1029 qs.stringify({ a: date }),
1030 'a=' + date.toISOString().replace(/:/g, '%3A'),
1031 'default is toISOString'
1032 );
1033
1034 var mutatedDate = new Date();
1035 mutatedDate.toISOString = function () {
1036 throw new SyntaxError();
1037 };
1038 st['throws'](function () {
1039 mutatedDate.toISOString();
1040 }, SyntaxError);
1041 st.equal(
1042 qs.stringify({ a: mutatedDate }),
1043 'a=' + Date.prototype.toISOString.call(mutatedDate).replace(/:/g, '%3A'),
1044 'toISOString works even when method is not locally present'
1045 );
1046
1047 var specificDate = new Date(6);
1048 st.equal(
1049 qs.stringify(
1050 { a: specificDate },
1051 { serializeDate: function (d) { return d.getTime() * 7; } }
1052 ),
1053 'a=42',
1054 'custom serializeDate function called'
1055 );
1056
1057 st.equal(
1058 qs.stringify(
1059 { a: [date] },
1060 {
1061 serializeDate: function (d) { return d.getTime(); },
1062 arrayFormat: 'comma'
1063 }
1064 ),
1065 'a=' + date.getTime(),
1066 'works with arrayFormat comma'
1067 );
1068 st.equal(
1069 qs.stringify(
1070 { a: [date] },
1071 {
1072 serializeDate: function (d) { return d.getTime(); },
1073 arrayFormat: 'comma',
1074 commaRoundTrip: true
1075 }
1076 ),
1077 'a%5B%5D=' + date.getTime(),
1078 'works with arrayFormat comma'
1079 );
1080
1081 st.end();
1082 });
1083
1084 t.test('RFC 1738 serialization', function (st) {
1085 st.equal(qs.stringify({ a: 'b c' }, { format: qs.formats.RFC1738 }), 'a=b+c');
1086 st.equal(qs.stringify({ 'a b': 'c d' }, { format: qs.formats.RFC1738 }), 'a+b=c+d');
1087 st.equal(qs.stringify({ 'a b': SaferBuffer.from('a b') }, { format: qs.formats.RFC1738 }), 'a+b=a+b');
1088
1089 st.equal(qs.stringify({ 'foo(ref)': 'bar' }, { format: qs.formats.RFC1738 }), 'foo(ref)=bar');
1090
1091 st.end();
1092 });
1093
1094 t.test('RFC 3986 spaces serialization', function (st) {
1095 st.equal(qs.stringify({ a: 'b c' }, { format: qs.formats.RFC3986 }), 'a=b%20c');
1096 st.equal(qs.stringify({ 'a b': 'c d' }, { format: qs.formats.RFC3986 }), 'a%20b=c%20d');
1097 st.equal(qs.stringify({ 'a b': SaferBuffer.from('a b') }, { format: qs.formats.RFC3986 }), 'a%20b=a%20b');
1098
1099 st.end();
1100 });
1101
1102 t.test('Backward compatibility to RFC 3986', function (st) {
1103 st.equal(qs.stringify({ a: 'b c' }), 'a=b%20c');
1104 st.equal(qs.stringify({ 'a b': SaferBuffer.from('a b') }), 'a%20b=a%20b');
1105
1106 st.end();
1107 });
1108
1109 t.test('Edge cases and unknown formats', function (st) {
1110 ['UFO1234', false, 1234, null, {}, []].forEach(function (format) {
1111 st['throws'](
1112 function () {
1113 qs.stringify({ a: 'b c' }, { format: format });
1114 },
1115 new TypeError('Unknown format option provided.')
1116 );
1117 });
1118 st.end();
1119 });
1120
1121 t.test('encodeValuesOnly', function (st) {
1122 st.equal(
1123 qs.stringify(
1124 { a: 'b', c: ['d', 'e=f'], f: [['g'], ['h']] },
1125 { encodeValuesOnly: true, arrayFormat: 'indices' }
1126 ),
1127 'a=b&c[0]=d&c[1]=e%3Df&f[0][0]=g&f[1][0]=h',
1128 'encodeValuesOnly + indices'
1129 );
1130 st.equal(
1131 qs.stringify(
1132 { a: 'b', c: ['d', 'e=f'], f: [['g'], ['h']] },
1133 { encodeValuesOnly: true, arrayFormat: 'brackets' }
1134 ),
1135 'a=b&c[]=d&c[]=e%3Df&f[][]=g&f[][]=h',
1136 'encodeValuesOnly + brackets'
1137 );
1138 st.equal(
1139 qs.stringify(
1140 { a: 'b', c: ['d', 'e=f'], f: [['g'], ['h']] },
1141 { encodeValuesOnly: true, arrayFormat: 'repeat' }
1142 ),
1143 'a=b&c=d&c=e%3Df&f=g&f=h',
1144 'encodeValuesOnly + repeat'
1145 );
1146
1147 st.equal(
1148 qs.stringify(
1149 { a: 'b', c: ['d', 'e'], f: [['g'], ['h']] },
1150 { arrayFormat: 'indices' }
1151 ),
1152 'a=b&c%5B0%5D=d&c%5B1%5D=e&f%5B0%5D%5B0%5D=g&f%5B1%5D%5B0%5D=h',
1153 'no encodeValuesOnly + indices'
1154 );
1155 st.equal(
1156 qs.stringify(
1157 { a: 'b', c: ['d', 'e'], f: [['g'], ['h']] },
1158 { arrayFormat: 'brackets' }
1159 ),
1160 'a=b&c%5B%5D=d&c%5B%5D=e&f%5B%5D%5B%5D=g&f%5B%5D%5B%5D=h',
1161 'no encodeValuesOnly + brackets'
1162 );
1163 st.equal(
1164 qs.stringify(
1165 { a: 'b', c: ['d', 'e'], f: [['g'], ['h']] },
1166 { arrayFormat: 'repeat' }
1167 ),
1168 'a=b&c=d&c=e&f=g&f=h',
1169 'no encodeValuesOnly + repeat'
1170 );
1171
1172 st.end();
1173 });
1174
1175 t.test('encodeValuesOnly - strictNullHandling', function (st) {
1176 st.equal(
1177 qs.stringify(
1178 { a: { b: null } },
1179 { encodeValuesOnly: true, strictNullHandling: true }
1180 ),
1181 'a[b]'
1182 );
1183 st.end();
1184 });
1185
1186 t.test('strictNullHandling: applies the formatter to the encoded key (RFC1738)', function (st) {
1187 st.equal(
1188 qs.stringify(
1189 { 'a b': null, 'c d': 'e f' },
1190 { strictNullHandling: false, format: 'RFC1738' }
1191 ),
1192 'a+b=&c+d=e+f',
1193 'without: as expected'
1194 );
1195
1196 st.equal(
1197 qs.stringify(
1198 { 'a b': null, 'c d': 'e f' },
1199 { strictNullHandling: true, format: 'RFC1738' }
1200 ),
1201 'a+b&c+d=e+f',
1202 'with: as expected'
1203 );
1204
1205 st.end();
1206 });
1207
1208 t.test('throws if an invalid charset is specified', function (st) {
1209 st['throws'](function () {
1210 qs.stringify({ a: 'b' }, { charset: 'foobar' });
1211 }, new TypeError('The charset option must be either utf-8, iso-8859-1, or undefined'));
1212 st.end();
1213 });
1214
1215 t.test('respects a charset of iso-8859-1', function (st) {
1216 st.equal(qs.stringify({ æ: 'æ' }, { charset: 'iso-8859-1' }), '%E6=%E6');
1217 st.end();
1218 });
1219
1220 t.test('encodes unrepresentable chars as numeric entities in iso-8859-1 mode', function (st) {
1221 st.equal(qs.stringify({ a: '☺' }, { charset: 'iso-8859-1' }), 'a=%26%239786%3B');
1222 st.end();
1223 });
1224
1225 t.test('respects an explicit charset of utf-8 (the default)', function (st) {
1226 st.equal(qs.stringify({ a: 'æ' }, { charset: 'utf-8' }), 'a=%C3%A6');
1227 st.end();
1228 });
1229
1230 t.test('`charsetSentinel` option', function (st) {
1231 st.equal(
1232 qs.stringify({ a: 'æ' }, { charsetSentinel: true, charset: 'utf-8' }),
1233 'utf8=%E2%9C%93&a=%C3%A6',
1234 'adds the right sentinel when instructed to and the charset is utf-8'
1235 );
1236
1237 st.equal(
1238 qs.stringify({ a: 'æ' }, { charsetSentinel: true, charset: 'iso-8859-1' }),
1239 'utf8=%26%2310003%3B&a=%E6',
1240 'adds the right sentinel when instructed to and the charset is iso-8859-1'
1241 );
1242
1243 st.equal(
1244 qs.stringify({ a: 1, b: 2 }, { charsetSentinel: true, delimiter: ';' }),
1245 'utf8=%E2%9C%93;a=1;b=2',
1246 'uses the configured delimiter after the sentinel'
1247 );
1248
1249 st.end();
1250 });
1251
1252 t.test('does not mutate the options argument', function (st) {
1253 var options = {};
1254 qs.stringify({}, options);
1255 st.deepEqual(options, {});
1256 st.end();
1257 });
1258
1259 t.test('strictNullHandling works with custom filter', function (st) {
1260 var filter = function (prefix, value) {
1261 return value;
1262 };
1263
1264 var options = { strictNullHandling: true, filter: filter };
1265 st.equal(qs.stringify({ key: null }, options), 'key');
1266 st.end();
1267 });
1268
1269 t.test('strictNullHandling works with null serializeDate', function (st) {
1270 var serializeDate = function () {
1271 return null;
1272 };
1273 var options = { strictNullHandling: true, serializeDate: serializeDate };
1274 var date = new Date();
1275 st.equal(qs.stringify({ key: date }, options), 'key');
1276 st.end();
1277 });
1278
1279 t.test('allows for encoding keys and values differently', function (st) {
1280 var encoder = function (str, defaultEncoder, charset, type) {
1281 if (type === 'key') {
1282 return defaultEncoder(str, defaultEncoder, charset, type).toLowerCase();
1283 }
1284 if (type === 'value') {
1285 return defaultEncoder(str, defaultEncoder, charset, type).toUpperCase();
1286 }
1287 throw 'this should never happen! type: ' + type;
1288 };
1289
1290 st.deepEqual(qs.stringify({ KeY: 'vAlUe' }, { encoder: encoder }), 'key=VALUE');
1291
1292 var noopEncoder = function () { return 'x'; };
1293 noopEncoder();
1294 st['throws'](
1295 function () { encoder('x', noopEncoder, 'utf-8', 'unknown'); },
1296 'this should never happen! type: unknown',
1297 'encoder throws for unexpected type'
1298 );
1299
1300 st.end();
1301 });
1302
1303 t.test('objects inside arrays', function (st) {
1304 var obj = { a: { b: { c: 'd', e: 'f' } } };
1305 var withArray = { a: { b: [{ c: 'd', e: 'f' }] } };
1306
1307 st.equal(qs.stringify(obj, { encode: false }), 'a[b][c]=d&a[b][e]=f', 'no array, no arrayFormat');
1308 st.equal(qs.stringify(obj, { encode: false, arrayFormat: 'brackets' }), 'a[b][c]=d&a[b][e]=f', 'no array, bracket');
1309 st.equal(qs.stringify(obj, { encode: false, arrayFormat: 'indices' }), 'a[b][c]=d&a[b][e]=f', 'no array, indices');
1310 st.equal(qs.stringify(obj, { encode: false, arrayFormat: 'repeat' }), 'a[b][c]=d&a[b][e]=f', 'no array, repeat');
1311 st.equal(qs.stringify(obj, { encode: false, arrayFormat: 'comma' }), 'a[b][c]=d&a[b][e]=f', 'no array, comma');
1312
1313 st.equal(qs.stringify(withArray, { encode: false }), 'a[b][0][c]=d&a[b][0][e]=f', 'array, no arrayFormat');
1314 st.equal(qs.stringify(withArray, { encode: false, arrayFormat: 'brackets' }), 'a[b][][c]=d&a[b][][e]=f', 'array, bracket');
1315 st.equal(qs.stringify(withArray, { encode: false, arrayFormat: 'indices' }), 'a[b][0][c]=d&a[b][0][e]=f', 'array, indices');
1316 st.equal(qs.stringify(withArray, { encode: false, arrayFormat: 'repeat' }), 'a[b][c]=d&a[b][e]=f', 'array, repeat');
1317 st.equal(
1318 qs.stringify(withArray, { encode: false, arrayFormat: 'comma' }),
1319 '???',
1320 'array, comma',
1321 { skip: 'TODO: figure out what this should do' }
1322 );
1323
1324 st.end();
1325 });
1326
1327 t.test('stringifies sparse arrays', function (st) {
1328 /* eslint no-sparse-arrays: 0 */
1329 st.equal(qs.stringify({ a: [, '2', , , '1'] }, { encodeValuesOnly: true, arrayFormat: 'indices' }), 'a[1]=2&a[4]=1');
1330 st.equal(qs.stringify({ a: [, '2', , , '1'] }, { encodeValuesOnly: true, arrayFormat: 'brackets' }), 'a[]=2&a[]=1');
1331 st.equal(qs.stringify({ a: [, '2', , , '1'] }, { encodeValuesOnly: true, arrayFormat: 'repeat' }), 'a=2&a=1');
1332
1333 st.equal(qs.stringify({ a: [, { b: [, , { c: '1' }] }] }, { encodeValuesOnly: true, arrayFormat: 'indices' }), 'a[1][b][2][c]=1');
1334 st.equal(qs.stringify({ a: [, { b: [, , { c: '1' }] }] }, { encodeValuesOnly: true, arrayFormat: 'brackets' }), 'a[][b][][c]=1');
1335 st.equal(qs.stringify({ a: [, { b: [, , { c: '1' }] }] }, { encodeValuesOnly: true, arrayFormat: 'repeat' }), 'a[b][c]=1');
1336
1337 st.equal(qs.stringify({ a: [, [, , [, , , { c: '1' }]]] }, { encodeValuesOnly: true, arrayFormat: 'indices' }), 'a[1][2][3][c]=1');
1338 st.equal(qs.stringify({ a: [, [, , [, , , { c: '1' }]]] }, { encodeValuesOnly: true, arrayFormat: 'brackets' }), 'a[][][][c]=1');
1339 st.equal(qs.stringify({ a: [, [, , [, , , { c: '1' }]]] }, { encodeValuesOnly: true, arrayFormat: 'repeat' }), 'a[c]=1');
1340
1341 st.equal(qs.stringify({ a: [, [, , [, , , { c: [, '1'] }]]] }, { encodeValuesOnly: true, arrayFormat: 'indices' }), 'a[1][2][3][c][1]=1');
1342 st.equal(qs.stringify({ a: [, [, , [, , , { c: [, '1'] }]]] }, { encodeValuesOnly: true, arrayFormat: 'brackets' }), 'a[][][][c][]=1');
1343 st.equal(qs.stringify({ a: [, [, , [, , , { c: [, '1'] }]]] }, { encodeValuesOnly: true, arrayFormat: 'repeat' }), 'a[c]=1');
1344
1345 st.end();
1346 });
1347
1348 t.test('encodes a very long string', function (st) {
1349 var chars = [];
1350 var expected = [];
1351 for (var i = 0; i < 5e3; i++) {
1352 chars.push(' ' + i);
1353
1354 expected.push('%20' + i);
1355 }
1356
1357 var obj = {
1358 foo: chars.join('')
1359 };
1360
1361 st.equal(
1362 qs.stringify(obj, { arrayFormat: 'brackets', charset: 'utf-8' }),
1363 'foo=' + expected.join('')
1364 );
1365
1366 st.end();
1367 });
1368
1369 t.end();
1370});
1371
1372test('stringifies empty keys', function (t) {
1373 emptyTestCases.forEach(function (testCase) {
1374 t.test('stringifies an object with empty string key with ' + testCase.input, function (st) {
1375 st.deepEqual(
1376 qs.stringify(testCase.withEmptyKeys, { encode: false, arrayFormat: 'indices' }),
1377 testCase.stringifyOutput.indices,
1378 'test case: ' + testCase.input + ', indices'
1379 );
1380 st.deepEqual(
1381 qs.stringify(testCase.withEmptyKeys, { encode: false, arrayFormat: 'brackets' }),
1382 testCase.stringifyOutput.brackets,
1383 'test case: ' + testCase.input + ', brackets'
1384 );
1385 st.deepEqual(
1386 qs.stringify(testCase.withEmptyKeys, { encode: false, arrayFormat: 'repeat' }),
1387 testCase.stringifyOutput.repeat,
1388 'test case: ' + testCase.input + ', repeat'
1389 );
1390
1391 st.end();
1392 });
1393 });
1394
1395 t.test('edge case with object/arrays', function (st) {
1396 st.deepEqual(qs.stringify({ '': { '': [2, 3] } }, { encode: false }), '[][0]=2&[][1]=3');
1397 st.deepEqual(qs.stringify({ '': { '': [2, 3], a: 2 } }, { encode: false }), '[][0]=2&[][1]=3&[a]=2');
1398 st.deepEqual(qs.stringify({ '': { '': [2, 3] } }, { encode: false, arrayFormat: 'indices' }), '[][0]=2&[][1]=3');
1399 st.deepEqual(qs.stringify({ '': { '': [2, 3], a: 2 } }, { encode: false, arrayFormat: 'indices' }), '[][0]=2&[][1]=3&[a]=2');
1400
1401 st.end();
1402 });
1403
1404 t.test('stringifies non-string keys', function (st) {
1405 var S = Object('abc');
1406 S.toString = function () {
1407 return 'd';
1408 };
1409 var actual = qs.stringify({ a: 'b', 'false': {}, 1e+22: 'c', d: 'e' }, {
1410 filter: ['a', false, null, 10000000000000000000000, S],
1411 allowDots: true,
1412 encodeDotInKeys: true
1413 });
1414
1415 st.equal(actual, 'a=b&1e%2B22=c&d=e', 'stringifies correctly');
1416
1417 st.end();
1418 });
1419
1420 t.test('round-trips keys containing percent-encoded bracket text', function (st) {
1421 var cases = [
1422 { 'a%5Bb': 'c' },
1423 { 'a%5Db': 'c' },
1424 { 'a%255Bb': 'c' },
1425 { 'a%255Db': 'c' },
1426 { a: { 'b%5Bc': 'd' } },
1427 { a: { 'b%255Bc': 'd' } },
1428 { 'a%5B%255Bb': 'c' }
1429 ];
1430 for (var i = 0; i < cases.length; i++) {
1431 st.deepEqual(
1432 qs.parse(qs.stringify(cases[i])),
1433 cases[i],
1434 'round-trips ' + JSON.stringify(cases[i])
1435 );
1436 }
1437
1438 st.end();
1439 });
1440
1441 t.test('parses input containing percent-encoded bracket text without mangling', function (st) {
1442 st.deepEqual(qs.parse('a%25255Bb=c'), { 'a%255Bb': 'c' }, 'a%25255Bb decodes to a%255Bb, not a%5Bb');
1443 st.deepEqual(qs.parse('a%25255Db=c'), { 'a%255Db': 'c' }, 'a%25255Db decodes to a%255Db, not a%5Db');
1444 st.deepEqual(qs.parse('a%5Bb%25255Bc%5D=d'), { a: { 'b%255Bc': 'd' } }, 'nested %25255B decodes to %255B inside segment, not %5B');
1445
1446 st.end();
1447 });
1448});
Note: See TracBrowser for help on using the repository browser.