stringify.js 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750
  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'] } }, { arrayFormat: 'indices' }), 'a%5Bb%5D%5B0%5D=c&a%5Bb%5D%5B1%5D=d');
  121. st.equal(qs.stringify({ a: { b: ['c', 'd'] } }, { arrayFormat: 'brackets' }), 'a%5Bb%5D%5B%5D=c&a%5Bb%5D%5B%5D=d');
  122. st.equal(qs.stringify({ a: { b: ['c', 'd'] } }, { arrayFormat: 'comma' }), 'a%5Bb%5D=c%2Cd'); // a[b]=c,d
  123. st.equal(qs.stringify({ a: { b: ['c', 'd'] } }), 'a%5Bb%5D%5B0%5D=c&a%5Bb%5D%5B1%5D=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, encode: false, 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, encode: false, 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, encode: false, 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, encode: false }
  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] }, { encode: false, 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] }, { encode: false, 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] }, { encode: false }),
  207. 'a[0][b]=1&a[1]=2&a[2]=3',
  208. 'default => indices'
  209. );
  210. st.end();
  211. });
  212. t.test('stringifies an object inside an array with dots notation', function (st) {
  213. st.equal(
  214. qs.stringify(
  215. { a: [{ b: 'c' }] },
  216. { allowDots: true, encode: false, arrayFormat: 'indices' }
  217. ),
  218. 'a[0].b=c',
  219. 'indices => indices'
  220. );
  221. st.equal(
  222. qs.stringify(
  223. { a: [{ b: 'c' }] },
  224. { allowDots: true, encode: false, arrayFormat: 'brackets' }
  225. ),
  226. 'a[].b=c',
  227. 'brackets => brackets'
  228. );
  229. st.equal(
  230. qs.stringify(
  231. { a: [{ b: 'c' }] },
  232. { allowDots: true, encode: false }
  233. ),
  234. 'a[0].b=c',
  235. 'default => indices'
  236. );
  237. st.equal(
  238. qs.stringify(
  239. { a: [{ b: { c: [1] } }] },
  240. { allowDots: true, encode: false, arrayFormat: 'indices' }
  241. ),
  242. 'a[0].b.c[0]=1',
  243. 'indices => indices'
  244. );
  245. st.equal(
  246. qs.stringify(
  247. { a: [{ b: { c: [1] } }] },
  248. { allowDots: true, encode: false, arrayFormat: 'brackets' }
  249. ),
  250. 'a[].b.c[]=1',
  251. 'brackets => brackets'
  252. );
  253. st.equal(
  254. qs.stringify(
  255. { a: [{ b: { c: [1] } }] },
  256. { allowDots: true, encode: false }
  257. ),
  258. 'a[0].b.c[0]=1',
  259. 'default => indices'
  260. );
  261. st.end();
  262. });
  263. t.test('does not omit object keys when indices = false', function (st) {
  264. st.equal(qs.stringify({ a: [{ b: 'c' }] }, { indices: false }), 'a%5Bb%5D=c');
  265. st.end();
  266. });
  267. t.test('uses indices notation for arrays when indices=true', function (st) {
  268. st.equal(qs.stringify({ a: ['b', 'c'] }, { indices: true }), 'a%5B0%5D=b&a%5B1%5D=c');
  269. st.end();
  270. });
  271. t.test('uses indices notation for arrays when no arrayFormat is specified', function (st) {
  272. st.equal(qs.stringify({ a: ['b', 'c'] }), 'a%5B0%5D=b&a%5B1%5D=c');
  273. st.end();
  274. });
  275. t.test('uses indices notation for arrays when no arrayFormat=indices', function (st) {
  276. st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'indices' }), 'a%5B0%5D=b&a%5B1%5D=c');
  277. st.end();
  278. });
  279. t.test('uses repeat notation for arrays when no arrayFormat=repeat', function (st) {
  280. st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'repeat' }), 'a=b&a=c');
  281. st.end();
  282. });
  283. t.test('uses brackets notation for arrays when no arrayFormat=brackets', function (st) {
  284. st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'brackets' }), 'a%5B%5D=b&a%5B%5D=c');
  285. st.end();
  286. });
  287. t.test('stringifies a complicated object', function (st) {
  288. st.equal(qs.stringify({ a: { b: 'c', d: 'e' } }), 'a%5Bb%5D=c&a%5Bd%5D=e');
  289. st.end();
  290. });
  291. t.test('stringifies an empty value', function (st) {
  292. st.equal(qs.stringify({ a: '' }), 'a=');
  293. st.equal(qs.stringify({ a: null }, { strictNullHandling: true }), 'a');
  294. st.equal(qs.stringify({ a: '', b: '' }), 'a=&b=');
  295. st.equal(qs.stringify({ a: null, b: '' }, { strictNullHandling: true }), 'a&b=');
  296. st.equal(qs.stringify({ a: { b: '' } }), 'a%5Bb%5D=');
  297. st.equal(qs.stringify({ a: { b: null } }, { strictNullHandling: true }), 'a%5Bb%5D');
  298. st.equal(qs.stringify({ a: { b: null } }, { strictNullHandling: false }), 'a%5Bb%5D=');
  299. st.end();
  300. });
  301. t.test('stringifies a null object', { skip: !Object.create }, function (st) {
  302. var obj = Object.create(null);
  303. obj.a = 'b';
  304. st.equal(qs.stringify(obj), 'a=b');
  305. st.end();
  306. });
  307. t.test('returns an empty string for invalid input', function (st) {
  308. st.equal(qs.stringify(undefined), '');
  309. st.equal(qs.stringify(false), '');
  310. st.equal(qs.stringify(null), '');
  311. st.equal(qs.stringify(''), '');
  312. st.end();
  313. });
  314. t.test('stringifies an object with a null object as a child', { skip: !Object.create }, function (st) {
  315. var obj = { a: Object.create(null) };
  316. obj.a.b = 'c';
  317. st.equal(qs.stringify(obj), 'a%5Bb%5D=c');
  318. st.end();
  319. });
  320. t.test('drops keys with a value of undefined', function (st) {
  321. st.equal(qs.stringify({ a: undefined }), '');
  322. st.equal(qs.stringify({ a: { b: undefined, c: null } }, { strictNullHandling: true }), 'a%5Bc%5D');
  323. st.equal(qs.stringify({ a: { b: undefined, c: null } }, { strictNullHandling: false }), 'a%5Bc%5D=');
  324. st.equal(qs.stringify({ a: { b: undefined, c: '' } }), 'a%5Bc%5D=');
  325. st.end();
  326. });
  327. t.test('url encodes values', function (st) {
  328. st.equal(qs.stringify({ a: 'b c' }), 'a=b%20c');
  329. st.end();
  330. });
  331. t.test('stringifies a date', function (st) {
  332. var now = new Date();
  333. var str = 'a=' + encodeURIComponent(now.toISOString());
  334. st.equal(qs.stringify({ a: now }), str);
  335. st.end();
  336. });
  337. t.test('stringifies the weird object from qs', function (st) {
  338. 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');
  339. st.end();
  340. });
  341. t.test('skips properties that are part of the object prototype', function (st) {
  342. Object.prototype.crash = 'test';
  343. st.equal(qs.stringify({ a: 'b' }), 'a=b');
  344. st.equal(qs.stringify({ a: { b: 'c' } }), 'a%5Bb%5D=c');
  345. delete Object.prototype.crash;
  346. st.end();
  347. });
  348. t.test('stringifies boolean values', function (st) {
  349. st.equal(qs.stringify({ a: true }), 'a=true');
  350. st.equal(qs.stringify({ a: { b: true } }), 'a%5Bb%5D=true');
  351. st.equal(qs.stringify({ b: false }), 'b=false');
  352. st.equal(qs.stringify({ b: { c: false } }), 'b%5Bc%5D=false');
  353. st.end();
  354. });
  355. t.test('stringifies buffer values', function (st) {
  356. st.equal(qs.stringify({ a: SaferBuffer.from('test') }), 'a=test');
  357. st.equal(qs.stringify({ a: { b: SaferBuffer.from('test') } }), 'a%5Bb%5D=test');
  358. st.end();
  359. });
  360. t.test('stringifies an object using an alternative delimiter', function (st) {
  361. st.equal(qs.stringify({ a: 'b', c: 'd' }, { delimiter: ';' }), 'a=b;c=d');
  362. st.end();
  363. });
  364. t.test('doesn\'t blow up when Buffer global is missing', function (st) {
  365. var tempBuffer = global.Buffer;
  366. delete global.Buffer;
  367. var result = qs.stringify({ a: 'b', c: 'd' });
  368. global.Buffer = tempBuffer;
  369. st.equal(result, 'a=b&c=d');
  370. st.end();
  371. });
  372. t.test('selects properties when filter=array', function (st) {
  373. st.equal(qs.stringify({ a: 'b' }, { filter: ['a'] }), 'a=b');
  374. st.equal(qs.stringify({ a: 1 }, { filter: [] }), '');
  375. st.equal(
  376. qs.stringify(
  377. { a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' },
  378. { filter: ['a', 'b', 0, 2], arrayFormat: 'indices' }
  379. ),
  380. 'a%5Bb%5D%5B0%5D=1&a%5Bb%5D%5B2%5D=3',
  381. 'indices => indices'
  382. );
  383. st.equal(
  384. qs.stringify(
  385. { a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' },
  386. { filter: ['a', 'b', 0, 2], arrayFormat: 'brackets' }
  387. ),
  388. 'a%5Bb%5D%5B%5D=1&a%5Bb%5D%5B%5D=3',
  389. 'brackets => brackets'
  390. );
  391. st.equal(
  392. qs.stringify(
  393. { a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' },
  394. { filter: ['a', 'b', 0, 2] }
  395. ),
  396. 'a%5Bb%5D%5B0%5D=1&a%5Bb%5D%5B2%5D=3',
  397. 'default => indices'
  398. );
  399. st.end();
  400. });
  401. t.test('supports custom representations when filter=function', function (st) {
  402. var calls = 0;
  403. var obj = { a: 'b', c: 'd', e: { f: new Date(1257894000000) } };
  404. var filterFunc = function (prefix, value) {
  405. calls += 1;
  406. if (calls === 1) {
  407. st.equal(prefix, '', 'prefix is empty');
  408. st.equal(value, obj);
  409. } else if (prefix === 'c') {
  410. return void 0;
  411. } else if (value instanceof Date) {
  412. st.equal(prefix, 'e[f]');
  413. return value.getTime();
  414. }
  415. return value;
  416. };
  417. st.equal(qs.stringify(obj, { filter: filterFunc }), 'a=b&e%5Bf%5D=1257894000000');
  418. st.equal(calls, 5);
  419. st.end();
  420. });
  421. t.test('can disable uri encoding', function (st) {
  422. st.equal(qs.stringify({ a: 'b' }, { encode: false }), 'a=b');
  423. st.equal(qs.stringify({ a: { b: 'c' } }, { encode: false }), 'a[b]=c');
  424. st.equal(qs.stringify({ a: 'b', c: null }, { strictNullHandling: true, encode: false }), 'a=b&c');
  425. st.end();
  426. });
  427. t.test('can sort the keys', function (st) {
  428. var sort = function (a, b) {
  429. return a.localeCompare(b);
  430. };
  431. st.equal(qs.stringify({ a: 'c', z: 'y', b: 'f' }, { sort: sort }), 'a=c&b=f&z=y');
  432. 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');
  433. st.end();
  434. });
  435. t.test('can sort the keys at depth 3 or more too', function (st) {
  436. var sort = function (a, b) {
  437. return a.localeCompare(b);
  438. };
  439. st.equal(
  440. qs.stringify(
  441. { a: 'a', z: { zj: { zjb: 'zjb', zja: 'zja' }, zi: { zib: 'zib', zia: 'zia' } }, b: 'b' },
  442. { sort: sort, encode: false }
  443. ),
  444. 'a=a&b=b&z[zi][zia]=zia&z[zi][zib]=zib&z[zj][zja]=zja&z[zj][zjb]=zjb'
  445. );
  446. st.equal(
  447. qs.stringify(
  448. { a: 'a', z: { zj: { zjb: 'zjb', zja: 'zja' }, zi: { zib: 'zib', zia: 'zia' } }, b: 'b' },
  449. { sort: null, encode: false }
  450. ),
  451. 'a=a&z[zj][zjb]=zjb&z[zj][zja]=zja&z[zi][zib]=zib&z[zi][zia]=zia&b=b'
  452. );
  453. st.end();
  454. });
  455. t.test('can stringify with custom encoding', function (st) {
  456. st.equal(qs.stringify({ 県: '大阪府', '': '' }, {
  457. encoder: function (str) {
  458. if (str.length === 0) {
  459. return '';
  460. }
  461. var buf = iconv.encode(str, 'shiftjis');
  462. var result = [];
  463. for (var i = 0; i < buf.length; ++i) {
  464. result.push(buf.readUInt8(i).toString(16));
  465. }
  466. return '%' + result.join('%');
  467. }
  468. }), '%8c%a7=%91%e5%8d%e3%95%7b&=');
  469. st.end();
  470. });
  471. t.test('receives the default encoder as a second argument', function (st) {
  472. st.plan(2);
  473. qs.stringify({ a: 1 }, {
  474. encoder: function (str, defaultEncoder) {
  475. st.equal(defaultEncoder, utils.encode);
  476. }
  477. });
  478. st.end();
  479. });
  480. t.test('throws error with wrong encoder', function (st) {
  481. st['throws'](function () {
  482. qs.stringify({}, { encoder: 'string' });
  483. }, new TypeError('Encoder has to be a function.'));
  484. st.end();
  485. });
  486. t.test('can use custom encoder for a buffer object', { skip: typeof Buffer === 'undefined' }, function (st) {
  487. st.equal(qs.stringify({ a: SaferBuffer.from([1]) }, {
  488. encoder: function (buffer) {
  489. if (typeof buffer === 'string') {
  490. return buffer;
  491. }
  492. return String.fromCharCode(buffer.readUInt8(0) + 97);
  493. }
  494. }), 'a=b');
  495. st.equal(qs.stringify({ a: SaferBuffer.from('a b') }, {
  496. encoder: function (buffer) {
  497. return buffer;
  498. }
  499. }), 'a=a b');
  500. st.end();
  501. });
  502. t.test('serializeDate option', function (st) {
  503. var date = new Date();
  504. st.equal(
  505. qs.stringify({ a: date }),
  506. 'a=' + date.toISOString().replace(/:/g, '%3A'),
  507. 'default is toISOString'
  508. );
  509. var mutatedDate = new Date();
  510. mutatedDate.toISOString = function () {
  511. throw new SyntaxError();
  512. };
  513. st['throws'](function () {
  514. mutatedDate.toISOString();
  515. }, SyntaxError);
  516. st.equal(
  517. qs.stringify({ a: mutatedDate }),
  518. 'a=' + Date.prototype.toISOString.call(mutatedDate).replace(/:/g, '%3A'),
  519. 'toISOString works even when method is not locally present'
  520. );
  521. var specificDate = new Date(6);
  522. st.equal(
  523. qs.stringify(
  524. { a: specificDate },
  525. { serializeDate: function (d) { return d.getTime() * 7; } }
  526. ),
  527. 'a=42',
  528. 'custom serializeDate function called'
  529. );
  530. st.equal(
  531. qs.stringify(
  532. { a: [date] },
  533. {
  534. serializeDate: function (d) { return d.getTime(); },
  535. arrayFormat: 'comma'
  536. }
  537. ),
  538. 'a=' + date.getTime(),
  539. 'works with arrayFormat comma'
  540. );
  541. st.end();
  542. });
  543. t.test('RFC 1738 spaces serialization', function (st) {
  544. st.equal(qs.stringify({ a: 'b c' }, { format: qs.formats.RFC1738 }), 'a=b+c');
  545. st.equal(qs.stringify({ 'a b': 'c d' }, { format: qs.formats.RFC1738 }), 'a+b=c+d');
  546. st.equal(qs.stringify({ 'a b': SaferBuffer.from('a b') }, { format: qs.formats.RFC1738 }), 'a+b=a+b');
  547. st.end();
  548. });
  549. t.test('RFC 3986 spaces serialization', function (st) {
  550. st.equal(qs.stringify({ a: 'b c' }, { format: qs.formats.RFC3986 }), 'a=b%20c');
  551. st.equal(qs.stringify({ 'a b': 'c d' }, { format: qs.formats.RFC3986 }), 'a%20b=c%20d');
  552. st.equal(qs.stringify({ 'a b': SaferBuffer.from('a b') }, { format: qs.formats.RFC3986 }), 'a%20b=a%20b');
  553. st.end();
  554. });
  555. t.test('Backward compatibility to RFC 3986', function (st) {
  556. st.equal(qs.stringify({ a: 'b c' }), 'a=b%20c');
  557. st.equal(qs.stringify({ 'a b': SaferBuffer.from('a b') }), 'a%20b=a%20b');
  558. st.end();
  559. });
  560. t.test('Edge cases and unknown formats', function (st) {
  561. ['UFO1234', false, 1234, null, {}, []].forEach(
  562. function (format) {
  563. st['throws'](
  564. function () {
  565. qs.stringify({ a: 'b c' }, { format: format });
  566. },
  567. new TypeError('Unknown format option provided.')
  568. );
  569. }
  570. );
  571. st.end();
  572. });
  573. t.test('encodeValuesOnly', function (st) {
  574. st.equal(
  575. qs.stringify(
  576. { a: 'b', c: ['d', 'e=f'], f: [['g'], ['h']] },
  577. { encodeValuesOnly: true }
  578. ),
  579. 'a=b&c[0]=d&c[1]=e%3Df&f[0][0]=g&f[1][0]=h'
  580. );
  581. st.equal(
  582. qs.stringify(
  583. { a: 'b', c: ['d', 'e'], f: [['g'], ['h']] }
  584. ),
  585. 'a=b&c%5B0%5D=d&c%5B1%5D=e&f%5B0%5D%5B0%5D=g&f%5B1%5D%5B0%5D=h'
  586. );
  587. st.end();
  588. });
  589. t.test('encodeValuesOnly - strictNullHandling', function (st) {
  590. st.equal(
  591. qs.stringify(
  592. { a: { b: null } },
  593. { encodeValuesOnly: true, strictNullHandling: true }
  594. ),
  595. 'a[b]'
  596. );
  597. st.end();
  598. });
  599. t.test('throws if an invalid charset is specified', function (st) {
  600. st['throws'](function () {
  601. qs.stringify({ a: 'b' }, { charset: 'foobar' });
  602. }, new TypeError('The charset option must be either utf-8, iso-8859-1, or undefined'));
  603. st.end();
  604. });
  605. t.test('respects a charset of iso-8859-1', function (st) {
  606. st.equal(qs.stringify({ æ: 'æ' }, { charset: 'iso-8859-1' }), '%E6=%E6');
  607. st.end();
  608. });
  609. t.test('encodes unrepresentable chars as numeric entities in iso-8859-1 mode', function (st) {
  610. st.equal(qs.stringify({ a: '☺' }, { charset: 'iso-8859-1' }), 'a=%26%239786%3B');
  611. st.end();
  612. });
  613. t.test('respects an explicit charset of utf-8 (the default)', function (st) {
  614. st.equal(qs.stringify({ a: 'æ' }, { charset: 'utf-8' }), 'a=%C3%A6');
  615. st.end();
  616. });
  617. t.test('adds the right sentinel when instructed to and the charset is utf-8', function (st) {
  618. st.equal(qs.stringify({ a: 'æ' }, { charsetSentinel: true, charset: 'utf-8' }), 'utf8=%E2%9C%93&a=%C3%A6');
  619. st.end();
  620. });
  621. t.test('adds the right sentinel when instructed to and the charset is iso-8859-1', function (st) {
  622. st.equal(qs.stringify({ a: 'æ' }, { charsetSentinel: true, charset: 'iso-8859-1' }), 'utf8=%26%2310003%3B&a=%E6');
  623. st.end();
  624. });
  625. t.test('does not mutate the options argument', function (st) {
  626. var options = {};
  627. qs.stringify({}, options);
  628. st.deepEqual(options, {});
  629. st.end();
  630. });
  631. t.test('strictNullHandling works with custom filter', function (st) {
  632. var filter = function (prefix, value) {
  633. return value;
  634. };
  635. var options = { strictNullHandling: true, filter: filter };
  636. st.equal(qs.stringify({ key: null }, options), 'key');
  637. st.end();
  638. });
  639. t.test('strictNullHandling works with null serializeDate', function (st) {
  640. var serializeDate = function () {
  641. return null;
  642. };
  643. var options = { strictNullHandling: true, serializeDate: serializeDate };
  644. var date = new Date();
  645. st.equal(qs.stringify({ key: date }, options), 'key');
  646. st.end();
  647. });
  648. t.test('allows for encoding keys and values differently', function (st) {
  649. var encoder = function (str, defaultEncoder, charset, type) {
  650. if (type === 'key') {
  651. return defaultEncoder(str, defaultEncoder, charset, type).toLowerCase();
  652. }
  653. if (type === 'value') {
  654. return defaultEncoder(str, defaultEncoder, charset, type).toUpperCase();
  655. }
  656. throw 'this should never happen! type: ' + type;
  657. };
  658. st.deepEqual(qs.stringify({ KeY: 'vAlUe' }, { encoder: encoder }), 'key=VALUE');
  659. st.end();
  660. });
  661. t.end();
  662. });