stringify.js 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865
  1. 'use strict';
  2. var test = require('tape');
  3. var qs = require('../');
  4. var utils = require('../lib/utils');
  5. var iconv = require('iconv-lite');
  6. var SaferBuffer = require('safer-buffer').Buffer;
  7. var hasSymbols = require('has-symbols');
  8. var hasBigInt = typeof BigInt === 'function';
  9. test('stringify()', function (t) {
  10. t.test('stringifies a querystring object', function (st) {
  11. st.equal(qs.stringify({ a: 'b' }), 'a=b');
  12. st.equal(qs.stringify({ a: 1 }), 'a=1');
  13. st.equal(qs.stringify({ a: 1, b: 2 }), 'a=1&b=2');
  14. st.equal(qs.stringify({ a: 'A_Z' }), 'a=A_Z');
  15. st.equal(qs.stringify({ a: '€' }), 'a=%E2%82%AC');
  16. st.equal(qs.stringify({ a: '' }), 'a=%EE%80%80');
  17. st.equal(qs.stringify({ a: 'א' }), 'a=%D7%90');
  18. st.equal(qs.stringify({ a: '𐐷' }), 'a=%F0%90%90%B7');
  19. st.end();
  20. });
  21. t.test('stringifies falsy values', function (st) {
  22. st.equal(qs.stringify(undefined), '');
  23. st.equal(qs.stringify(null), '');
  24. st.equal(qs.stringify(null, { strictNullHandling: true }), '');
  25. st.equal(qs.stringify(false), '');
  26. st.equal(qs.stringify(0), '');
  27. st.end();
  28. });
  29. t.test('stringifies symbols', { skip: !hasSymbols() }, function (st) {
  30. st.equal(qs.stringify(Symbol.iterator), '');
  31. st.equal(qs.stringify([Symbol.iterator]), '0=Symbol%28Symbol.iterator%29');
  32. st.equal(qs.stringify({ a: Symbol.iterator }), 'a=Symbol%28Symbol.iterator%29');
  33. st.equal(
  34. qs.stringify({ a: [Symbol.iterator] }, { encodeValuesOnly: true, arrayFormat: 'brackets' }),
  35. 'a[]=Symbol%28Symbol.iterator%29'
  36. );
  37. st.end();
  38. });
  39. t.test('stringifies bigints', { skip: !hasBigInt }, function (st) {
  40. var three = BigInt(3);
  41. var encodeWithN = function (value, defaultEncoder, charset) {
  42. var result = defaultEncoder(value, defaultEncoder, charset);
  43. return typeof value === 'bigint' ? result + 'n' : result;
  44. };
  45. st.equal(qs.stringify(three), '');
  46. st.equal(qs.stringify([three]), '0=3');
  47. st.equal(qs.stringify([three], { encoder: encodeWithN }), '0=3n');
  48. st.equal(qs.stringify({ a: three }), 'a=3');
  49. st.equal(qs.stringify({ a: three }, { encoder: encodeWithN }), 'a=3n');
  50. st.equal(
  51. qs.stringify({ a: [three] }, { encodeValuesOnly: true, arrayFormat: 'brackets' }),
  52. 'a[]=3'
  53. );
  54. st.equal(
  55. qs.stringify({ a: [three] }, { encodeValuesOnly: true, encoder: encodeWithN, arrayFormat: 'brackets' }),
  56. 'a[]=3n'
  57. );
  58. st.end();
  59. });
  60. t.test('adds query prefix', function (st) {
  61. st.equal(qs.stringify({ a: 'b' }, { addQueryPrefix: true }), '?a=b');
  62. st.end();
  63. });
  64. t.test('with query prefix, outputs blank string given an empty object', function (st) {
  65. st.equal(qs.stringify({}, { addQueryPrefix: true }), '');
  66. st.end();
  67. });
  68. t.test('stringifies nested falsy values', function (st) {
  69. st.equal(qs.stringify({ a: { b: { c: null } } }), 'a%5Bb%5D%5Bc%5D=');
  70. st.equal(qs.stringify({ a: { b: { c: null } } }, { strictNullHandling: true }), 'a%5Bb%5D%5Bc%5D');
  71. st.equal(qs.stringify({ a: { b: { c: false } } }), 'a%5Bb%5D%5Bc%5D=false');
  72. st.end();
  73. });
  74. t.test('stringifies a nested object', function (st) {
  75. st.equal(qs.stringify({ a: { b: 'c' } }), 'a%5Bb%5D=c');
  76. st.equal(qs.stringify({ a: { b: { c: { d: 'e' } } } }), 'a%5Bb%5D%5Bc%5D%5Bd%5D=e');
  77. st.end();
  78. });
  79. t.test('stringifies a nested object with dots notation', function (st) {
  80. st.equal(qs.stringify({ a: { b: 'c' } }, { allowDots: true }), 'a.b=c');
  81. st.equal(qs.stringify({ a: { b: { c: { d: 'e' } } } }, { allowDots: true }), 'a.b.c.d=e');
  82. st.end();
  83. });
  84. t.test('stringifies an array value', function (st) {
  85. st.equal(
  86. qs.stringify({ a: ['b', 'c', 'd'] }, { arrayFormat: 'indices' }),
  87. 'a%5B0%5D=b&a%5B1%5D=c&a%5B2%5D=d',
  88. 'indices => indices'
  89. );
  90. st.equal(
  91. qs.stringify({ a: ['b', 'c', 'd'] }, { arrayFormat: 'brackets' }),
  92. 'a%5B%5D=b&a%5B%5D=c&a%5B%5D=d',
  93. 'brackets => brackets'
  94. );
  95. st.equal(
  96. qs.stringify({ a: ['b', 'c', 'd'] }, { arrayFormat: 'comma' }),
  97. 'a=b%2Cc%2Cd',
  98. 'comma => comma'
  99. );
  100. st.equal(
  101. qs.stringify({ a: ['b', 'c', 'd'] }),
  102. 'a%5B0%5D=b&a%5B1%5D=c&a%5B2%5D=d',
  103. 'default => indices'
  104. );
  105. st.end();
  106. });
  107. t.test('omits nulls when asked', function (st) {
  108. st.equal(qs.stringify({ a: 'b', c: null }, { skipNulls: true }), 'a=b');
  109. st.end();
  110. });
  111. t.test('omits nested nulls when asked', function (st) {
  112. st.equal(qs.stringify({ a: { b: 'c', d: null } }, { skipNulls: true }), 'a%5Bb%5D=c');
  113. st.end();
  114. });
  115. t.test('omits array indices when asked', function (st) {
  116. st.equal(qs.stringify({ a: ['b', 'c', 'd'] }, { indices: false }), 'a=b&a=c&a=d');
  117. st.end();
  118. });
  119. t.test('stringifies a nested array value', function (st) {
  120. st.equal(qs.stringify({ a: { b: ['c', 'd'] } }, { encodeValuesOnly: true, arrayFormat: 'indices' }), 'a[b][0]=c&a[b][1]=d');
  121. st.equal(qs.stringify({ a: { b: ['c', 'd'] } }, { encodeValuesOnly: true, arrayFormat: 'brackets' }), 'a[b][]=c&a[b][]=d');
  122. st.equal(qs.stringify({ a: { b: ['c', 'd'] } }, { encodeValuesOnly: true, arrayFormat: 'comma' }), 'a[b]=c,d');
  123. st.equal(qs.stringify({ a: { b: ['c', 'd'] } }, { encodeValuesOnly: true }), 'a[b][0]=c&a[b][1]=d');
  124. st.end();
  125. });
  126. t.test('stringifies a nested array value with dots notation', function (st) {
  127. st.equal(
  128. qs.stringify(
  129. { a: { b: ['c', 'd'] } },
  130. { allowDots: true, encodeValuesOnly: true, arrayFormat: 'indices' }
  131. ),
  132. 'a.b[0]=c&a.b[1]=d',
  133. 'indices: stringifies with dots + indices'
  134. );
  135. st.equal(
  136. qs.stringify(
  137. { a: { b: ['c', 'd'] } },
  138. { allowDots: true, encodeValuesOnly: true, arrayFormat: 'brackets' }
  139. ),
  140. 'a.b[]=c&a.b[]=d',
  141. 'brackets: stringifies with dots + brackets'
  142. );
  143. st.equal(
  144. qs.stringify(
  145. { a: { b: ['c', 'd'] } },
  146. { allowDots: true, encodeValuesOnly: true, arrayFormat: 'comma' }
  147. ),
  148. 'a.b=c,d',
  149. 'comma: stringifies with dots + comma'
  150. );
  151. st.equal(
  152. qs.stringify(
  153. { a: { b: ['c', 'd'] } },
  154. { allowDots: true, encodeValuesOnly: true }
  155. ),
  156. 'a.b[0]=c&a.b[1]=d',
  157. 'default: stringifies with dots + indices'
  158. );
  159. st.end();
  160. });
  161. t.test('stringifies an object inside an array', function (st) {
  162. st.equal(
  163. qs.stringify({ a: [{ b: 'c' }] }, { arrayFormat: 'indices' }),
  164. 'a%5B0%5D%5Bb%5D=c', // a[0][b]=c
  165. 'indices => brackets'
  166. );
  167. st.equal(
  168. qs.stringify({ a: [{ b: 'c' }] }, { arrayFormat: 'brackets' }),
  169. 'a%5B%5D%5Bb%5D=c', // a[][b]=c
  170. 'brackets => brackets'
  171. );
  172. st.equal(
  173. qs.stringify({ a: [{ b: 'c' }] }),
  174. 'a%5B0%5D%5Bb%5D=c',
  175. 'default => indices'
  176. );
  177. st.equal(
  178. qs.stringify({ a: [{ b: { c: [1] } }] }, { arrayFormat: 'indices' }),
  179. 'a%5B0%5D%5Bb%5D%5Bc%5D%5B0%5D=1',
  180. 'indices => indices'
  181. );
  182. st.equal(
  183. qs.stringify({ a: [{ b: { c: [1] } }] }, { arrayFormat: 'brackets' }),
  184. 'a%5B%5D%5Bb%5D%5Bc%5D%5B%5D=1',
  185. 'brackets => brackets'
  186. );
  187. st.equal(
  188. qs.stringify({ a: [{ b: { c: [1] } }] }),
  189. 'a%5B0%5D%5Bb%5D%5Bc%5D%5B0%5D=1',
  190. 'default => indices'
  191. );
  192. st.end();
  193. });
  194. t.test('stringifies an array with mixed objects and primitives', function (st) {
  195. st.equal(
  196. qs.stringify({ a: [{ b: 1 }, 2, 3] }, { encodeValuesOnly: true, arrayFormat: 'indices' }),
  197. 'a[0][b]=1&a[1]=2&a[2]=3',
  198. 'indices => indices'
  199. );
  200. st.equal(
  201. qs.stringify({ a: [{ b: 1 }, 2, 3] }, { encodeValuesOnly: true, arrayFormat: 'brackets' }),
  202. 'a[][b]=1&a[]=2&a[]=3',
  203. 'brackets => brackets'
  204. );
  205. st.equal(
  206. qs.stringify({ a: [{ b: 1 }, 2, 3] }, { encodeValuesOnly: true, arrayFormat: 'comma' }),
  207. '???',
  208. 'brackets => brackets',
  209. { skip: 'TODO: figure out what this should do' }
  210. );
  211. st.equal(
  212. qs.stringify({ a: [{ b: 1 }, 2, 3] }, { encodeValuesOnly: true }),
  213. 'a[0][b]=1&a[1]=2&a[2]=3',
  214. 'default => indices'
  215. );
  216. st.end();
  217. });
  218. t.test('stringifies an object inside an array with dots notation', function (st) {
  219. st.equal(
  220. qs.stringify(
  221. { a: [{ b: 'c' }] },
  222. { allowDots: true, encode: false, arrayFormat: 'indices' }
  223. ),
  224. 'a[0].b=c',
  225. 'indices => indices'
  226. );
  227. st.equal(
  228. qs.stringify(
  229. { a: [{ b: 'c' }] },
  230. { allowDots: true, encode: false, arrayFormat: 'brackets' }
  231. ),
  232. 'a[].b=c',
  233. 'brackets => brackets'
  234. );
  235. st.equal(
  236. qs.stringify(
  237. { a: [{ b: 'c' }] },
  238. { allowDots: true, encode: false }
  239. ),
  240. 'a[0].b=c',
  241. 'default => indices'
  242. );
  243. st.equal(
  244. qs.stringify(
  245. { a: [{ b: { c: [1] } }] },
  246. { allowDots: true, encode: false, arrayFormat: 'indices' }
  247. ),
  248. 'a[0].b.c[0]=1',
  249. 'indices => indices'
  250. );
  251. st.equal(
  252. qs.stringify(
  253. { a: [{ b: { c: [1] } }] },
  254. { allowDots: true, encode: false, arrayFormat: 'brackets' }
  255. ),
  256. 'a[].b.c[]=1',
  257. 'brackets => brackets'
  258. );
  259. st.equal(
  260. qs.stringify(
  261. { a: [{ b: { c: [1] } }] },
  262. { allowDots: true, encode: false }
  263. ),
  264. 'a[0].b.c[0]=1',
  265. 'default => indices'
  266. );
  267. st.end();
  268. });
  269. t.test('does not omit object keys when indices = false', function (st) {
  270. st.equal(qs.stringify({ a: [{ b: 'c' }] }, { indices: false }), 'a%5Bb%5D=c');
  271. st.end();
  272. });
  273. t.test('uses indices notation for arrays when indices=true', function (st) {
  274. st.equal(qs.stringify({ a: ['b', 'c'] }, { indices: true }), 'a%5B0%5D=b&a%5B1%5D=c');
  275. st.end();
  276. });
  277. t.test('uses indices notation for arrays when no arrayFormat is specified', function (st) {
  278. st.equal(qs.stringify({ a: ['b', 'c'] }), 'a%5B0%5D=b&a%5B1%5D=c');
  279. st.end();
  280. });
  281. t.test('uses indices notation for arrays when no arrayFormat=indices', function (st) {
  282. st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'indices' }), 'a%5B0%5D=b&a%5B1%5D=c');
  283. st.end();
  284. });
  285. t.test('uses repeat notation for arrays when no arrayFormat=repeat', function (st) {
  286. st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'repeat' }), 'a=b&a=c');
  287. st.end();
  288. });
  289. t.test('uses brackets notation for arrays when no arrayFormat=brackets', function (st) {
  290. st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'brackets' }), 'a%5B%5D=b&a%5B%5D=c');
  291. st.end();
  292. });
  293. t.test('stringifies a complicated object', function (st) {
  294. st.equal(qs.stringify({ a: { b: 'c', d: 'e' } }), 'a%5Bb%5D=c&a%5Bd%5D=e');
  295. st.end();
  296. });
  297. t.test('stringifies an empty value', function (st) {
  298. st.equal(qs.stringify({ a: '' }), 'a=');
  299. st.equal(qs.stringify({ a: null }, { strictNullHandling: true }), 'a');
  300. st.equal(qs.stringify({ a: '', b: '' }), 'a=&b=');
  301. st.equal(qs.stringify({ a: null, b: '' }, { strictNullHandling: true }), 'a&b=');
  302. st.equal(qs.stringify({ a: { b: '' } }), 'a%5Bb%5D=');
  303. st.equal(qs.stringify({ a: { b: null } }, { strictNullHandling: true }), 'a%5Bb%5D');
  304. st.equal(qs.stringify({ a: { b: null } }, { strictNullHandling: false }), 'a%5Bb%5D=');
  305. st.end();
  306. });
  307. t.test('stringifies an empty array in different arrayFormat', function (st) {
  308. st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false }), 'b[0]=&c=c');
  309. // arrayFormat default
  310. st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'indices' }), 'b[0]=&c=c');
  311. st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'brackets' }), 'b[]=&c=c');
  312. st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'repeat' }), 'b=&c=c');
  313. st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'comma' }), 'b=&c=c');
  314. // with strictNullHandling
  315. st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'indices', strictNullHandling: true }), 'b[0]&c=c');
  316. st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'brackets', strictNullHandling: true }), 'b[]&c=c');
  317. st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'repeat', strictNullHandling: true }), 'b&c=c');
  318. st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'comma', strictNullHandling: true }), 'b&c=c');
  319. // with skipNulls
  320. st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'indices', skipNulls: true }), 'c=c');
  321. st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'brackets', skipNulls: true }), 'c=c');
  322. st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'repeat', skipNulls: true }), 'c=c');
  323. st.equal(qs.stringify({ a: [], b: [null], c: 'c' }, { encode: false, arrayFormat: 'comma', skipNulls: true }), 'c=c');
  324. st.end();
  325. });
  326. t.test('stringifies a null object', { skip: !Object.create }, function (st) {
  327. var obj = Object.create(null);
  328. obj.a = 'b';
  329. st.equal(qs.stringify(obj), 'a=b');
  330. st.end();
  331. });
  332. t.test('returns an empty string for invalid input', function (st) {
  333. st.equal(qs.stringify(undefined), '');
  334. st.equal(qs.stringify(false), '');
  335. st.equal(qs.stringify(null), '');
  336. st.equal(qs.stringify(''), '');
  337. st.end();
  338. });
  339. t.test('stringifies an object with a null object as a child', { skip: !Object.create }, function (st) {
  340. var obj = { a: Object.create(null) };
  341. obj.a.b = 'c';
  342. st.equal(qs.stringify(obj), 'a%5Bb%5D=c');
  343. st.end();
  344. });
  345. t.test('drops keys with a value of undefined', function (st) {
  346. st.equal(qs.stringify({ a: undefined }), '');
  347. st.equal(qs.stringify({ a: { b: undefined, c: null } }, { strictNullHandling: true }), 'a%5Bc%5D');
  348. st.equal(qs.stringify({ a: { b: undefined, c: null } }, { strictNullHandling: false }), 'a%5Bc%5D=');
  349. st.equal(qs.stringify({ a: { b: undefined, c: '' } }), 'a%5Bc%5D=');
  350. st.end();
  351. });
  352. t.test('url encodes values', function (st) {
  353. st.equal(qs.stringify({ a: 'b c' }), 'a=b%20c');
  354. st.end();
  355. });
  356. t.test('stringifies a date', function (st) {
  357. var now = new Date();
  358. var str = 'a=' + encodeURIComponent(now.toISOString());
  359. st.equal(qs.stringify({ a: now }), str);
  360. st.end();
  361. });
  362. t.test('stringifies the weird object from qs', function (st) {
  363. 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');
  364. st.end();
  365. });
  366. t.test('skips properties that are part of the object prototype', function (st) {
  367. Object.prototype.crash = 'test';
  368. st.equal(qs.stringify({ a: 'b' }), 'a=b');
  369. st.equal(qs.stringify({ a: { b: 'c' } }), 'a%5Bb%5D=c');
  370. delete Object.prototype.crash;
  371. st.end();
  372. });
  373. t.test('stringifies boolean values', function (st) {
  374. st.equal(qs.stringify({ a: true }), 'a=true');
  375. st.equal(qs.stringify({ a: { b: true } }), 'a%5Bb%5D=true');
  376. st.equal(qs.stringify({ b: false }), 'b=false');
  377. st.equal(qs.stringify({ b: { c: false } }), 'b%5Bc%5D=false');
  378. st.end();
  379. });
  380. t.test('stringifies buffer values', function (st) {
  381. st.equal(qs.stringify({ a: SaferBuffer.from('test') }), 'a=test');
  382. st.equal(qs.stringify({ a: { b: SaferBuffer.from('test') } }), 'a%5Bb%5D=test');
  383. st.end();
  384. });
  385. t.test('stringifies an object using an alternative delimiter', function (st) {
  386. st.equal(qs.stringify({ a: 'b', c: 'd' }, { delimiter: ';' }), 'a=b;c=d');
  387. st.end();
  388. });
  389. t.test('does not blow up when Buffer global is missing', function (st) {
  390. var tempBuffer = global.Buffer;
  391. delete global.Buffer;
  392. var result = qs.stringify({ a: 'b', c: 'd' });
  393. global.Buffer = tempBuffer;
  394. st.equal(result, 'a=b&c=d');
  395. st.end();
  396. });
  397. t.test('does not crash when parsing circular references', function (st) {
  398. var a = {};
  399. a.b = a;
  400. st['throws'](
  401. function () { qs.stringify({ 'foo[bar]': 'baz', 'foo[baz]': a }); },
  402. /RangeError: Cyclic object value/,
  403. 'cyclic values throw'
  404. );
  405. var circular = {
  406. a: 'value'
  407. };
  408. circular.a = circular;
  409. st['throws'](
  410. function () { qs.stringify(circular); },
  411. /RangeError: Cyclic object value/,
  412. 'cyclic values throw'
  413. );
  414. var arr = ['a'];
  415. st.doesNotThrow(
  416. function () { qs.stringify({ x: arr, y: arr }); },
  417. 'non-cyclic values do not throw'
  418. );
  419. st.end();
  420. });
  421. t.test('non-circular duplicated references can still work', function (st) {
  422. var hourOfDay = {
  423. 'function': 'hour_of_day'
  424. };
  425. var p1 = {
  426. 'function': 'gte',
  427. arguments: [hourOfDay, 0]
  428. };
  429. var p2 = {
  430. 'function': 'lte',
  431. arguments: [hourOfDay, 23]
  432. };
  433. st.equal(
  434. qs.stringify({ filters: { $and: [p1, p2] } }, { encodeValuesOnly: true }),
  435. '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'
  436. );
  437. st.end();
  438. });
  439. t.test('selects properties when filter=array', function (st) {
  440. st.equal(qs.stringify({ a: 'b' }, { filter: ['a'] }), 'a=b');
  441. st.equal(qs.stringify({ a: 1 }, { filter: [] }), '');
  442. st.equal(
  443. qs.stringify(
  444. { a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' },
  445. { filter: ['a', 'b', 0, 2], arrayFormat: 'indices' }
  446. ),
  447. 'a%5Bb%5D%5B0%5D=1&a%5Bb%5D%5B2%5D=3',
  448. 'indices => indices'
  449. );
  450. st.equal(
  451. qs.stringify(
  452. { a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' },
  453. { filter: ['a', 'b', 0, 2], arrayFormat: 'brackets' }
  454. ),
  455. 'a%5Bb%5D%5B%5D=1&a%5Bb%5D%5B%5D=3',
  456. 'brackets => brackets'
  457. );
  458. st.equal(
  459. qs.stringify(
  460. { a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' },
  461. { filter: ['a', 'b', 0, 2] }
  462. ),
  463. 'a%5Bb%5D%5B0%5D=1&a%5Bb%5D%5B2%5D=3',
  464. 'default => indices'
  465. );
  466. st.end();
  467. });
  468. t.test('supports custom representations when filter=function', function (st) {
  469. var calls = 0;
  470. var obj = { a: 'b', c: 'd', e: { f: new Date(1257894000000) } };
  471. var filterFunc = function (prefix, value) {
  472. calls += 1;
  473. if (calls === 1) {
  474. st.equal(prefix, '', 'prefix is empty');
  475. st.equal(value, obj);
  476. } else if (prefix === 'c') {
  477. return void 0;
  478. } else if (value instanceof Date) {
  479. st.equal(prefix, 'e[f]');
  480. return value.getTime();
  481. }
  482. return value;
  483. };
  484. st.equal(qs.stringify(obj, { filter: filterFunc }), 'a=b&e%5Bf%5D=1257894000000');
  485. st.equal(calls, 5);
  486. st.end();
  487. });
  488. t.test('can disable uri encoding', function (st) {
  489. st.equal(qs.stringify({ a: 'b' }, { encode: false }), 'a=b');
  490. st.equal(qs.stringify({ a: { b: 'c' } }, { encode: false }), 'a[b]=c');
  491. st.equal(qs.stringify({ a: 'b', c: null }, { strictNullHandling: true, encode: false }), 'a=b&c');
  492. st.end();
  493. });
  494. t.test('can sort the keys', function (st) {
  495. var sort = function (a, b) {
  496. return a.localeCompare(b);
  497. };
  498. st.equal(qs.stringify({ a: 'c', z: 'y', b: 'f' }, { sort: sort }), 'a=c&b=f&z=y');
  499. 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');
  500. st.end();
  501. });
  502. t.test('can sort the keys at depth 3 or more too', function (st) {
  503. var sort = function (a, b) {
  504. return a.localeCompare(b);
  505. };
  506. st.equal(
  507. qs.stringify(
  508. { a: 'a', z: { zj: { zjb: 'zjb', zja: 'zja' }, zi: { zib: 'zib', zia: 'zia' } }, b: 'b' },
  509. { sort: sort, encode: false }
  510. ),
  511. 'a=a&b=b&z[zi][zia]=zia&z[zi][zib]=zib&z[zj][zja]=zja&z[zj][zjb]=zjb'
  512. );
  513. st.equal(
  514. qs.stringify(
  515. { a: 'a', z: { zj: { zjb: 'zjb', zja: 'zja' }, zi: { zib: 'zib', zia: 'zia' } }, b: 'b' },
  516. { sort: null, encode: false }
  517. ),
  518. 'a=a&z[zj][zjb]=zjb&z[zj][zja]=zja&z[zi][zib]=zib&z[zi][zia]=zia&b=b'
  519. );
  520. st.end();
  521. });
  522. t.test('can stringify with custom encoding', function (st) {
  523. st.equal(qs.stringify({ 県: '大阪府', '': '' }, {
  524. encoder: function (str) {
  525. if (str.length === 0) {
  526. return '';
  527. }
  528. var buf = iconv.encode(str, 'shiftjis');
  529. var result = [];
  530. for (var i = 0; i < buf.length; ++i) {
  531. result.push(buf.readUInt8(i).toString(16));
  532. }
  533. return '%' + result.join('%');
  534. }
  535. }), '%8c%a7=%91%e5%8d%e3%95%7b&=');
  536. st.end();
  537. });
  538. t.test('receives the default encoder as a second argument', function (st) {
  539. st.plan(2);
  540. qs.stringify({ a: 1 }, {
  541. encoder: function (str, defaultEncoder) {
  542. st.equal(defaultEncoder, utils.encode);
  543. }
  544. });
  545. st.end();
  546. });
  547. t.test('throws error with wrong encoder', function (st) {
  548. st['throws'](function () {
  549. qs.stringify({}, { encoder: 'string' });
  550. }, new TypeError('Encoder has to be a function.'));
  551. st.end();
  552. });
  553. t.test('can use custom encoder for a buffer object', { skip: typeof Buffer === 'undefined' }, function (st) {
  554. st.equal(qs.stringify({ a: SaferBuffer.from([1]) }, {
  555. encoder: function (buffer) {
  556. if (typeof buffer === 'string') {
  557. return buffer;
  558. }
  559. return String.fromCharCode(buffer.readUInt8(0) + 97);
  560. }
  561. }), 'a=b');
  562. st.equal(qs.stringify({ a: SaferBuffer.from('a b') }, {
  563. encoder: function (buffer) {
  564. return buffer;
  565. }
  566. }), 'a=a b');
  567. st.end();
  568. });
  569. t.test('serializeDate option', function (st) {
  570. var date = new Date();
  571. st.equal(
  572. qs.stringify({ a: date }),
  573. 'a=' + date.toISOString().replace(/:/g, '%3A'),
  574. 'default is toISOString'
  575. );
  576. var mutatedDate = new Date();
  577. mutatedDate.toISOString = function () {
  578. throw new SyntaxError();
  579. };
  580. st['throws'](function () {
  581. mutatedDate.toISOString();
  582. }, SyntaxError);
  583. st.equal(
  584. qs.stringify({ a: mutatedDate }),
  585. 'a=' + Date.prototype.toISOString.call(mutatedDate).replace(/:/g, '%3A'),
  586. 'toISOString works even when method is not locally present'
  587. );
  588. var specificDate = new Date(6);
  589. st.equal(
  590. qs.stringify(
  591. { a: specificDate },
  592. { serializeDate: function (d) { return d.getTime() * 7; } }
  593. ),
  594. 'a=42',
  595. 'custom serializeDate function called'
  596. );
  597. st.equal(
  598. qs.stringify(
  599. { a: [date] },
  600. {
  601. serializeDate: function (d) { return d.getTime(); },
  602. arrayFormat: 'comma'
  603. }
  604. ),
  605. 'a=' + date.getTime(),
  606. 'works with arrayFormat comma'
  607. );
  608. st.end();
  609. });
  610. t.test('RFC 1738 serialization', function (st) {
  611. st.equal(qs.stringify({ a: 'b c' }, { format: qs.formats.RFC1738 }), 'a=b+c');
  612. st.equal(qs.stringify({ 'a b': 'c d' }, { format: qs.formats.RFC1738 }), 'a+b=c+d');
  613. st.equal(qs.stringify({ 'a b': SaferBuffer.from('a b') }, { format: qs.formats.RFC1738 }), 'a+b=a+b');
  614. st.equal(qs.stringify({ 'foo(ref)': 'bar' }, { format: qs.formats.RFC1738 }), 'foo(ref)=bar');
  615. st.end();
  616. });
  617. t.test('RFC 3986 spaces serialization', function (st) {
  618. st.equal(qs.stringify({ a: 'b c' }, { format: qs.formats.RFC3986 }), 'a=b%20c');
  619. st.equal(qs.stringify({ 'a b': 'c d' }, { format: qs.formats.RFC3986 }), 'a%20b=c%20d');
  620. st.equal(qs.stringify({ 'a b': SaferBuffer.from('a b') }, { format: qs.formats.RFC3986 }), 'a%20b=a%20b');
  621. st.end();
  622. });
  623. t.test('Backward compatibility to RFC 3986', function (st) {
  624. st.equal(qs.stringify({ a: 'b c' }), 'a=b%20c');
  625. st.equal(qs.stringify({ 'a b': SaferBuffer.from('a b') }), 'a%20b=a%20b');
  626. st.end();
  627. });
  628. t.test('Edge cases and unknown formats', function (st) {
  629. ['UFO1234', false, 1234, null, {}, []].forEach(
  630. function (format) {
  631. st['throws'](
  632. function () {
  633. qs.stringify({ a: 'b c' }, { format: format });
  634. },
  635. new TypeError('Unknown format option provided.')
  636. );
  637. }
  638. );
  639. st.end();
  640. });
  641. t.test('encodeValuesOnly', function (st) {
  642. st.equal(
  643. qs.stringify(
  644. { a: 'b', c: ['d', 'e=f'], f: [['g'], ['h']] },
  645. { encodeValuesOnly: true }
  646. ),
  647. 'a=b&c[0]=d&c[1]=e%3Df&f[0][0]=g&f[1][0]=h'
  648. );
  649. st.equal(
  650. qs.stringify(
  651. { a: 'b', c: ['d', 'e'], f: [['g'], ['h']] }
  652. ),
  653. 'a=b&c%5B0%5D=d&c%5B1%5D=e&f%5B0%5D%5B0%5D=g&f%5B1%5D%5B0%5D=h'
  654. );
  655. st.end();
  656. });
  657. t.test('encodeValuesOnly - strictNullHandling', function (st) {
  658. st.equal(
  659. qs.stringify(
  660. { a: { b: null } },
  661. { encodeValuesOnly: true, strictNullHandling: true }
  662. ),
  663. 'a[b]'
  664. );
  665. st.end();
  666. });
  667. t.test('throws if an invalid charset is specified', function (st) {
  668. st['throws'](function () {
  669. qs.stringify({ a: 'b' }, { charset: 'foobar' });
  670. }, new TypeError('The charset option must be either utf-8, iso-8859-1, or undefined'));
  671. st.end();
  672. });
  673. t.test('respects a charset of iso-8859-1', function (st) {
  674. st.equal(qs.stringify({ æ: 'æ' }, { charset: 'iso-8859-1' }), '%E6=%E6');
  675. st.end();
  676. });
  677. t.test('encodes unrepresentable chars as numeric entities in iso-8859-1 mode', function (st) {
  678. st.equal(qs.stringify({ a: '☺' }, { charset: 'iso-8859-1' }), 'a=%26%239786%3B');
  679. st.end();
  680. });
  681. t.test('respects an explicit charset of utf-8 (the default)', function (st) {
  682. st.equal(qs.stringify({ a: 'æ' }, { charset: 'utf-8' }), 'a=%C3%A6');
  683. st.end();
  684. });
  685. t.test('adds the right sentinel when instructed to and the charset is utf-8', function (st) {
  686. st.equal(qs.stringify({ a: 'æ' }, { charsetSentinel: true, charset: 'utf-8' }), 'utf8=%E2%9C%93&a=%C3%A6');
  687. st.end();
  688. });
  689. t.test('adds the right sentinel when instructed to and the charset is iso-8859-1', function (st) {
  690. st.equal(qs.stringify({ a: 'æ' }, { charsetSentinel: true, charset: 'iso-8859-1' }), 'utf8=%26%2310003%3B&a=%E6');
  691. st.end();
  692. });
  693. t.test('does not mutate the options argument', function (st) {
  694. var options = {};
  695. qs.stringify({}, options);
  696. st.deepEqual(options, {});
  697. st.end();
  698. });
  699. t.test('strictNullHandling works with custom filter', function (st) {
  700. var filter = function (prefix, value) {
  701. return value;
  702. };
  703. var options = { strictNullHandling: true, filter: filter };
  704. st.equal(qs.stringify({ key: null }, options), 'key');
  705. st.end();
  706. });
  707. t.test('strictNullHandling works with null serializeDate', function (st) {
  708. var serializeDate = function () {
  709. return null;
  710. };
  711. var options = { strictNullHandling: true, serializeDate: serializeDate };
  712. var date = new Date();
  713. st.equal(qs.stringify({ key: date }, options), 'key');
  714. st.end();
  715. });
  716. t.test('allows for encoding keys and values differently', function (st) {
  717. var encoder = function (str, defaultEncoder, charset, type) {
  718. if (type === 'key') {
  719. return defaultEncoder(str, defaultEncoder, charset, type).toLowerCase();
  720. }
  721. if (type === 'value') {
  722. return defaultEncoder(str, defaultEncoder, charset, type).toUpperCase();
  723. }
  724. throw 'this should never happen! type: ' + type;
  725. };
  726. st.deepEqual(qs.stringify({ KeY: 'vAlUe' }, { encoder: encoder }), 'key=VALUE');
  727. st.end();
  728. });
  729. t.test('objects inside arrays', function (st) {
  730. var obj = { a: { b: { c: 'd', e: 'f' } } };
  731. var withArray = { a: { b: [{ c: 'd', e: 'f' }] } };
  732. st.equal(qs.stringify(obj, { encode: false }), 'a[b][c]=d&a[b][e]=f', 'no array, no arrayFormat');
  733. st.equal(qs.stringify(obj, { encode: false, arrayFormat: 'bracket' }), 'a[b][c]=d&a[b][e]=f', 'no array, bracket');
  734. st.equal(qs.stringify(obj, { encode: false, arrayFormat: 'indices' }), 'a[b][c]=d&a[b][e]=f', 'no array, indices');
  735. st.equal(qs.stringify(obj, { encode: false, arrayFormat: 'comma' }), 'a[b][c]=d&a[b][e]=f', 'no array, comma');
  736. st.equal(qs.stringify(withArray, { encode: false }), 'a[b][0][c]=d&a[b][0][e]=f', 'array, no arrayFormat');
  737. st.equal(qs.stringify(withArray, { encode: false, arrayFormat: 'bracket' }), 'a[b][0][c]=d&a[b][0][e]=f', 'array, bracket');
  738. st.equal(qs.stringify(withArray, { encode: false, arrayFormat: 'indices' }), 'a[b][0][c]=d&a[b][0][e]=f', 'array, indices');
  739. st.equal(
  740. qs.stringify(withArray, { encode: false, arrayFormat: 'comma' }),
  741. '???',
  742. 'array, comma',
  743. { skip: 'TODO: figure out what this should do' }
  744. );
  745. st.end();
  746. });
  747. t.test('stringifies sparse arrays', function (st) {
  748. /* eslint no-sparse-arrays: 0 */
  749. st.equal(qs.stringify({ a: [, '2', , , '1'] }, { encodeValuesOnly: true }), 'a[1]=2&a[4]=1');
  750. st.equal(qs.stringify({ a: [, { b: [, , { c: '1' }] }] }, { encodeValuesOnly: true }), 'a[1][b][2][c]=1');
  751. st.equal(qs.stringify({ a: [, [, , [, , , { c: '1' }]]] }, { encodeValuesOnly: true }), 'a[1][2][3][c]=1');
  752. st.equal(qs.stringify({ a: [, [, , [, , , { c: [, '1'] }]]] }, { encodeValuesOnly: true }), 'a[1][2][3][c][1]=1');
  753. st.end();
  754. });
  755. t.end();
  756. });