stringify.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538
  1. 'use strict';
  2. var test = require('tape');
  3. var qs = require('../');
  4. var iconv = require('iconv-lite');
  5. test('stringify()', function (t) {
  6. t.test('stringifies a querystring object', function (st) {
  7. st.equal(qs.stringify({ a: 'b' }), 'a=b');
  8. st.equal(qs.stringify({ a: 1 }), 'a=1');
  9. st.equal(qs.stringify({ a: 1, b: 2 }), 'a=1&b=2');
  10. st.equal(qs.stringify({ a: 'A_Z' }), 'a=A_Z');
  11. st.equal(qs.stringify({ a: '€' }), 'a=%E2%82%AC');
  12. st.equal(qs.stringify({ a: '' }), 'a=%EE%80%80');
  13. st.equal(qs.stringify({ a: 'א' }), 'a=%D7%90');
  14. st.equal(qs.stringify({ a: '𐐷' }), 'a=%F0%90%90%B7');
  15. st.end();
  16. });
  17. t.test('stringifies a nested object', function (st) {
  18. st.equal(qs.stringify({ a: { b: 'c' } }), 'a%5Bb%5D=c');
  19. st.equal(qs.stringify({ a: { b: { c: { d: 'e' } } } }), 'a%5Bb%5D%5Bc%5D%5Bd%5D=e');
  20. st.end();
  21. });
  22. t.test('stringifies a nested object with dots notation', function (st) {
  23. st.equal(qs.stringify({ a: { b: 'c' } }, { allowDots: true }), 'a.b=c');
  24. st.equal(qs.stringify({ a: { b: { c: { d: 'e' } } } }, { allowDots: true }), 'a.b.c.d=e');
  25. st.end();
  26. });
  27. t.test('stringifies an array value', function (st) {
  28. st.equal(
  29. qs.stringify({ a: ['b', 'c', 'd'] }, { arrayFormat: 'indices' }),
  30. 'a%5B0%5D=b&a%5B1%5D=c&a%5B2%5D=d',
  31. 'indices => indices'
  32. );
  33. st.equal(
  34. qs.stringify({ a: ['b', 'c', 'd'] }, { arrayFormat: 'brackets' }),
  35. 'a%5B%5D=b&a%5B%5D=c&a%5B%5D=d',
  36. 'brackets => brackets'
  37. );
  38. st.equal(
  39. qs.stringify({ a: ['b', 'c', 'd'] }),
  40. 'a%5B0%5D=b&a%5B1%5D=c&a%5B2%5D=d',
  41. 'default => indices'
  42. );
  43. st.end();
  44. });
  45. t.test('omits nulls when asked', function (st) {
  46. st.equal(qs.stringify({ a: 'b', c: null }, { skipNulls: true }), 'a=b');
  47. st.end();
  48. });
  49. t.test('omits nested nulls when asked', function (st) {
  50. st.equal(qs.stringify({ a: { b: 'c', d: null } }, { skipNulls: true }), 'a%5Bb%5D=c');
  51. st.end();
  52. });
  53. t.test('omits array indices when asked', function (st) {
  54. st.equal(qs.stringify({ a: ['b', 'c', 'd'] }, { indices: false }), 'a=b&a=c&a=d');
  55. st.end();
  56. });
  57. t.test('stringifies a nested array value', function (st) {
  58. st.equal(qs.stringify({ a: { b: ['c', 'd'] } }, { arrayFormat: 'indices' }), 'a%5Bb%5D%5B0%5D=c&a%5Bb%5D%5B1%5D=d');
  59. st.equal(qs.stringify({ a: { b: ['c', 'd'] } }, { arrayFormat: 'brackets' }), 'a%5Bb%5D%5B%5D=c&a%5Bb%5D%5B%5D=d');
  60. st.equal(qs.stringify({ a: { b: ['c', 'd'] } }), 'a%5Bb%5D%5B0%5D=c&a%5Bb%5D%5B1%5D=d');
  61. st.end();
  62. });
  63. t.test('stringifies a nested array value with dots notation', function (st) {
  64. st.equal(
  65. qs.stringify(
  66. { a: { b: ['c', 'd'] } },
  67. { allowDots: true, encode: false, arrayFormat: 'indices' }
  68. ),
  69. 'a.b[0]=c&a.b[1]=d',
  70. 'indices: stringifies with dots + indices'
  71. );
  72. st.equal(
  73. qs.stringify(
  74. { a: { b: ['c', 'd'] } },
  75. { allowDots: true, encode: false, arrayFormat: 'brackets' }
  76. ),
  77. 'a.b[]=c&a.b[]=d',
  78. 'brackets: stringifies with dots + brackets'
  79. );
  80. st.equal(
  81. qs.stringify(
  82. { a: { b: ['c', 'd'] } },
  83. { allowDots: true, encode: false }
  84. ),
  85. 'a.b[0]=c&a.b[1]=d',
  86. 'default: stringifies with dots + indices'
  87. );
  88. st.end();
  89. });
  90. t.test('stringifies an object inside an array', function (st) {
  91. st.equal(
  92. qs.stringify({ a: [{ b: 'c' }] }, { arrayFormat: 'indices' }),
  93. 'a%5B0%5D%5Bb%5D=c',
  94. 'indices => brackets'
  95. );
  96. st.equal(
  97. qs.stringify({ a: [{ b: 'c' }] }, { arrayFormat: 'brackets' }),
  98. 'a%5B%5D%5Bb%5D=c',
  99. 'brackets => brackets'
  100. );
  101. st.equal(
  102. qs.stringify({ a: [{ b: 'c' }] }),
  103. 'a%5B0%5D%5Bb%5D=c',
  104. 'default => indices'
  105. );
  106. st.equal(
  107. qs.stringify({ a: [{ b: { c: [1] } }] }, { arrayFormat: 'indices' }),
  108. 'a%5B0%5D%5Bb%5D%5Bc%5D%5B0%5D=1',
  109. 'indices => indices'
  110. );
  111. st.equal(
  112. qs.stringify({ a: [{ b: { c: [1] } }] }, { arrayFormat: 'brackets' }),
  113. 'a%5B%5D%5Bb%5D%5Bc%5D%5B%5D=1',
  114. 'brackets => brackets'
  115. );
  116. st.equal(
  117. qs.stringify({ a: [{ b: { c: [1] } }] }),
  118. 'a%5B0%5D%5Bb%5D%5Bc%5D%5B0%5D=1',
  119. 'default => indices'
  120. );
  121. st.end();
  122. });
  123. t.test('stringifies an array with mixed objects and primitives', function (st) {
  124. st.equal(
  125. qs.stringify({ a: [{ b: 1 }, 2, 3] }, { encode: false, arrayFormat: 'indices' }),
  126. 'a[0][b]=1&a[1]=2&a[2]=3',
  127. 'indices => indices'
  128. );
  129. st.equal(
  130. qs.stringify({ a: [{ b: 1 }, 2, 3] }, { encode: false, arrayFormat: 'brackets' }),
  131. 'a[][b]=1&a[]=2&a[]=3',
  132. 'brackets => brackets'
  133. );
  134. st.equal(
  135. qs.stringify({ a: [{ b: 1 }, 2, 3] }, { encode: false }),
  136. 'a[0][b]=1&a[1]=2&a[2]=3',
  137. 'default => indices'
  138. );
  139. st.end();
  140. });
  141. t.test('stringifies an object inside an array with dots notation', function (st) {
  142. st.equal(
  143. qs.stringify(
  144. { a: [{ b: 'c' }] },
  145. { allowDots: true, encode: false, arrayFormat: 'indices' }
  146. ),
  147. 'a[0].b=c',
  148. 'indices => indices'
  149. );
  150. st.equal(
  151. qs.stringify(
  152. { a: [{ b: 'c' }] },
  153. { allowDots: true, encode: false, arrayFormat: 'brackets' }
  154. ),
  155. 'a[].b=c',
  156. 'brackets => brackets'
  157. );
  158. st.equal(
  159. qs.stringify(
  160. { a: [{ b: 'c' }] },
  161. { allowDots: true, encode: false }
  162. ),
  163. 'a[0].b=c',
  164. 'default => indices'
  165. );
  166. st.equal(
  167. qs.stringify(
  168. { a: [{ b: { c: [1] } }] },
  169. { allowDots: true, encode: false, arrayFormat: 'indices' }
  170. ),
  171. 'a[0].b.c[0]=1',
  172. 'indices => indices'
  173. );
  174. st.equal(
  175. qs.stringify(
  176. { a: [{ b: { c: [1] } }] },
  177. { allowDots: true, encode: false, arrayFormat: 'brackets' }
  178. ),
  179. 'a[].b.c[]=1',
  180. 'brackets => brackets'
  181. );
  182. st.equal(
  183. qs.stringify(
  184. { a: [{ b: { c: [1] } }] },
  185. { allowDots: true, encode: false }
  186. ),
  187. 'a[0].b.c[0]=1',
  188. 'default => indices'
  189. );
  190. st.end();
  191. });
  192. t.test('does not omit object keys when indices = false', function (st) {
  193. st.equal(qs.stringify({ a: [{ b: 'c' }] }, { indices: false }), 'a%5Bb%5D=c');
  194. st.end();
  195. });
  196. t.test('uses indices notation for arrays when indices=true', function (st) {
  197. st.equal(qs.stringify({ a: ['b', 'c'] }, { indices: true }), 'a%5B0%5D=b&a%5B1%5D=c');
  198. st.end();
  199. });
  200. t.test('uses indices notation for arrays when no arrayFormat is specified', function (st) {
  201. st.equal(qs.stringify({ a: ['b', 'c'] }), 'a%5B0%5D=b&a%5B1%5D=c');
  202. st.end();
  203. });
  204. t.test('uses indices notation for arrays when no arrayFormat=indices', function (st) {
  205. st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'indices' }), 'a%5B0%5D=b&a%5B1%5D=c');
  206. st.end();
  207. });
  208. t.test('uses repeat notation for arrays when no arrayFormat=repeat', function (st) {
  209. st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'repeat' }), 'a=b&a=c');
  210. st.end();
  211. });
  212. t.test('uses brackets notation for arrays when no arrayFormat=brackets', function (st) {
  213. st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'brackets' }), 'a%5B%5D=b&a%5B%5D=c');
  214. st.end();
  215. });
  216. t.test('stringifies a complicated object', function (st) {
  217. st.equal(qs.stringify({ a: { b: 'c', d: 'e' } }), 'a%5Bb%5D=c&a%5Bd%5D=e');
  218. st.end();
  219. });
  220. t.test('stringifies an empty value', function (st) {
  221. st.equal(qs.stringify({ a: '' }), 'a=');
  222. st.equal(qs.stringify({ a: null }, { strictNullHandling: true }), 'a');
  223. st.equal(qs.stringify({ a: '', b: '' }), 'a=&b=');
  224. st.equal(qs.stringify({ a: null, b: '' }, { strictNullHandling: true }), 'a&b=');
  225. st.equal(qs.stringify({ a: { b: '' } }), 'a%5Bb%5D=');
  226. st.equal(qs.stringify({ a: { b: null } }, { strictNullHandling: true }), 'a%5Bb%5D');
  227. st.equal(qs.stringify({ a: { b: null } }, { strictNullHandling: false }), 'a%5Bb%5D=');
  228. st.end();
  229. });
  230. t.test('stringifies a null object', { skip: !Object.create }, function (st) {
  231. var obj = Object.create(null);
  232. obj.a = 'b';
  233. st.equal(qs.stringify(obj), 'a=b');
  234. st.end();
  235. });
  236. t.test('returns an empty string for invalid input', function (st) {
  237. st.equal(qs.stringify(undefined), '');
  238. st.equal(qs.stringify(false), '');
  239. st.equal(qs.stringify(null), '');
  240. st.equal(qs.stringify(''), '');
  241. st.end();
  242. });
  243. t.test('stringifies an object with a null object as a child', { skip: !Object.create }, function (st) {
  244. var obj = { a: Object.create(null) };
  245. obj.a.b = 'c';
  246. st.equal(qs.stringify(obj), 'a%5Bb%5D=c');
  247. st.end();
  248. });
  249. t.test('drops keys with a value of undefined', function (st) {
  250. st.equal(qs.stringify({ a: undefined }), '');
  251. st.equal(qs.stringify({ a: { b: undefined, c: null } }, { strictNullHandling: true }), 'a%5Bc%5D');
  252. st.equal(qs.stringify({ a: { b: undefined, c: null } }, { strictNullHandling: false }), 'a%5Bc%5D=');
  253. st.equal(qs.stringify({ a: { b: undefined, c: '' } }), 'a%5Bc%5D=');
  254. st.end();
  255. });
  256. t.test('url encodes values', function (st) {
  257. st.equal(qs.stringify({ a: 'b c' }), 'a=b%20c');
  258. st.end();
  259. });
  260. t.test('stringifies a date', function (st) {
  261. var now = new Date();
  262. var str = 'a=' + encodeURIComponent(now.toISOString());
  263. st.equal(qs.stringify({ a: now }), str);
  264. st.end();
  265. });
  266. t.test('stringifies the weird object from qs', function (st) {
  267. 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');
  268. st.end();
  269. });
  270. t.test('skips properties that are part of the object prototype', function (st) {
  271. Object.prototype.crash = 'test';
  272. st.equal(qs.stringify({ a: 'b' }), 'a=b');
  273. st.equal(qs.stringify({ a: { b: 'c' } }), 'a%5Bb%5D=c');
  274. delete Object.prototype.crash;
  275. st.end();
  276. });
  277. t.test('stringifies boolean values', function (st) {
  278. st.equal(qs.stringify({ a: true }), 'a=true');
  279. st.equal(qs.stringify({ a: { b: true } }), 'a%5Bb%5D=true');
  280. st.equal(qs.stringify({ b: false }), 'b=false');
  281. st.equal(qs.stringify({ b: { c: false } }), 'b%5Bc%5D=false');
  282. st.end();
  283. });
  284. t.test('stringifies buffer values', function (st) {
  285. st.equal(qs.stringify({ a: new Buffer('test') }), 'a=test');
  286. st.equal(qs.stringify({ a: { b: new Buffer('test') } }), 'a%5Bb%5D=test');
  287. st.end();
  288. });
  289. t.test('stringifies an object using an alternative delimiter', function (st) {
  290. st.equal(qs.stringify({ a: 'b', c: 'd' }, { delimiter: ';' }), 'a=b;c=d');
  291. st.end();
  292. });
  293. t.test('doesn\'t blow up when Buffer global is missing', function (st) {
  294. var tempBuffer = global.Buffer;
  295. delete global.Buffer;
  296. var result = qs.stringify({ a: 'b', c: 'd' });
  297. global.Buffer = tempBuffer;
  298. st.equal(result, 'a=b&c=d');
  299. st.end();
  300. });
  301. t.test('selects properties when filter=array', function (st) {
  302. st.equal(qs.stringify({ a: 'b' }, { filter: ['a'] }), 'a=b');
  303. st.equal(qs.stringify({ a: 1 }, { filter: [] }), '');
  304. st.equal(
  305. qs.stringify(
  306. { a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' },
  307. { filter: ['a', 'b', 0, 2], arrayFormat: 'indices' }
  308. ),
  309. 'a%5Bb%5D%5B0%5D=1&a%5Bb%5D%5B2%5D=3',
  310. 'indices => indices'
  311. );
  312. st.equal(
  313. qs.stringify(
  314. { a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' },
  315. { filter: ['a', 'b', 0, 2], arrayFormat: 'brackets' }
  316. ),
  317. 'a%5Bb%5D%5B%5D=1&a%5Bb%5D%5B%5D=3',
  318. 'brackets => brackets'
  319. );
  320. st.equal(
  321. qs.stringify(
  322. { a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' },
  323. { filter: ['a', 'b', 0, 2] }
  324. ),
  325. 'a%5Bb%5D%5B0%5D=1&a%5Bb%5D%5B2%5D=3',
  326. 'default => indices'
  327. );
  328. st.end();
  329. });
  330. t.test('supports custom representations when filter=function', function (st) {
  331. var calls = 0;
  332. var obj = { a: 'b', c: 'd', e: { f: new Date(1257894000000) } };
  333. var filterFunc = function (prefix, value) {
  334. calls += 1;
  335. if (calls === 1) {
  336. st.equal(prefix, '', 'prefix is empty');
  337. st.equal(value, obj);
  338. } else if (prefix === 'c') {
  339. return;
  340. } else if (value instanceof Date) {
  341. st.equal(prefix, 'e[f]');
  342. return value.getTime();
  343. }
  344. return value;
  345. };
  346. st.equal(qs.stringify(obj, { filter: filterFunc }), 'a=b&e%5Bf%5D=1257894000000');
  347. st.equal(calls, 5);
  348. st.end();
  349. });
  350. t.test('can disable uri encoding', function (st) {
  351. st.equal(qs.stringify({ a: 'b' }, { encode: false }), 'a=b');
  352. st.equal(qs.stringify({ a: { b: 'c' } }, { encode: false }), 'a[b]=c');
  353. st.equal(qs.stringify({ a: 'b', c: null }, { strictNullHandling: true, encode: false }), 'a=b&c');
  354. st.end();
  355. });
  356. t.test('can sort the keys', function (st) {
  357. var sort = function (a, b) {
  358. return a.localeCompare(b);
  359. };
  360. st.equal(qs.stringify({ a: 'c', z: 'y', b: 'f' }, { sort: sort }), 'a=c&b=f&z=y');
  361. 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');
  362. st.end();
  363. });
  364. t.test('can sort the keys at depth 3 or more too', function (st) {
  365. var sort = function (a, b) {
  366. return a.localeCompare(b);
  367. };
  368. st.equal(
  369. qs.stringify(
  370. { a: 'a', z: { zj: { zjb: 'zjb', zja: 'zja' }, zi: { zib: 'zib', zia: 'zia' } }, b: 'b' },
  371. { sort: sort, encode: false }
  372. ),
  373. 'a=a&b=b&z[zi][zia]=zia&z[zi][zib]=zib&z[zj][zja]=zja&z[zj][zjb]=zjb'
  374. );
  375. st.equal(
  376. qs.stringify(
  377. { a: 'a', z: { zj: { zjb: 'zjb', zja: 'zja' }, zi: { zib: 'zib', zia: 'zia' } }, b: 'b' },
  378. { sort: null, encode: false }
  379. ),
  380. 'a=a&z[zj][zjb]=zjb&z[zj][zja]=zja&z[zi][zib]=zib&z[zi][zia]=zia&b=b'
  381. );
  382. st.end();
  383. });
  384. t.test('can stringify with custom encoding', function (st) {
  385. st.equal(qs.stringify({ 県: '大阪府', '': '' }, {
  386. encoder: function (str) {
  387. if (str.length === 0) {
  388. return '';
  389. }
  390. var buf = iconv.encode(str, 'shiftjis');
  391. var result = [];
  392. for (var i = 0; i < buf.length; ++i) {
  393. result.push(buf.readUInt8(i).toString(16));
  394. }
  395. return '%' + result.join('%');
  396. }
  397. }), '%8c%a7=%91%e5%8d%e3%95%7b&=');
  398. st.end();
  399. });
  400. t.test('throws error with wrong encoder', function (st) {
  401. st.throws(function () {
  402. qs.stringify({}, { encoder: 'string' });
  403. }, new TypeError('Encoder has to be a function.'));
  404. st.end();
  405. });
  406. t.test('can use custom encoder for a buffer object', { skip: typeof Buffer === 'undefined' }, function (st) {
  407. st.equal(qs.stringify({ a: new Buffer([1]) }, {
  408. encoder: function (buffer) {
  409. if (typeof buffer === 'string') {
  410. return buffer;
  411. }
  412. return String.fromCharCode(buffer.readUInt8(0) + 97);
  413. }
  414. }), 'a=b');
  415. st.end();
  416. });
  417. t.test('serializeDate option', function (st) {
  418. var date = new Date();
  419. st.equal(
  420. qs.stringify({ a: date }),
  421. 'a=' + date.toISOString().replace(/:/g, '%3A'),
  422. 'default is toISOString'
  423. );
  424. var mutatedDate = new Date();
  425. mutatedDate.toISOString = function () {
  426. throw new SyntaxError();
  427. };
  428. st.throws(function () {
  429. mutatedDate.toISOString();
  430. }, SyntaxError);
  431. st.equal(
  432. qs.stringify({ a: mutatedDate }),
  433. 'a=' + Date.prototype.toISOString.call(mutatedDate).replace(/:/g, '%3A'),
  434. 'toISOString works even when method is not locally present'
  435. );
  436. var specificDate = new Date(6);
  437. st.equal(
  438. qs.stringify(
  439. { a: specificDate },
  440. { serializeDate: function (d) { return d.getTime() * 7; } }
  441. ),
  442. 'a=42',
  443. 'custom serializeDate function called'
  444. );
  445. st.end();
  446. });
  447. t.test('RFC 1738 spaces serialization', function (st) {
  448. st.equal(qs.stringify({ a: 'b c' }, { format: qs.formats.RFC1738 }), 'a=b+c');
  449. st.equal(qs.stringify({ 'a b': 'c d' }, { format: qs.formats.RFC1738 }), 'a+b=c+d');
  450. st.end();
  451. });
  452. t.test('RFC 3986 spaces serialization', function (st) {
  453. st.equal(qs.stringify({ a: 'b c' }, { format: qs.formats.RFC3986 }), 'a=b%20c');
  454. st.equal(qs.stringify({ 'a b': 'c d' }, { format: qs.formats.RFC3986 }), 'a%20b=c%20d');
  455. st.end();
  456. });
  457. t.test('Backward compatibility to RFC 3986', function (st) {
  458. st.equal(qs.stringify({ a: 'b c' }), 'a=b%20c');
  459. st.end();
  460. });
  461. t.test('Edge cases and unknown formats', function (st) {
  462. ['UFO1234', false, 1234, null, {}, []].forEach(
  463. function (format) {
  464. st.throws(
  465. function () {
  466. qs.stringify({ a: 'b c' }, { format: format });
  467. },
  468. new TypeError('Unknown format option provided.')
  469. );
  470. }
  471. );
  472. st.end();
  473. });
  474. });