stringify.js 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  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(qs.stringify({ a: ['b', 'c', 'd'] }), 'a%5B0%5D=b&a%5B1%5D=c&a%5B2%5D=d');
  29. st.end();
  30. });
  31. t.test('omits nulls when asked', function (st) {
  32. st.equal(qs.stringify({ a: 'b', c: null }, { skipNulls: true }), 'a=b');
  33. st.end();
  34. });
  35. t.test('omits nested nulls when asked', function (st) {
  36. st.equal(qs.stringify({ a: { b: 'c', d: null } }, { skipNulls: true }), 'a%5Bb%5D=c');
  37. st.end();
  38. });
  39. t.test('omits array indices when asked', function (st) {
  40. st.equal(qs.stringify({ a: ['b', 'c', 'd'] }, { indices: false }), 'a=b&a=c&a=d');
  41. st.end();
  42. });
  43. t.test('stringifies a nested array value', function (st) {
  44. st.equal(qs.stringify({ a: { b: ['c', 'd'] } }), 'a%5Bb%5D%5B0%5D=c&a%5Bb%5D%5B1%5D=d');
  45. st.end();
  46. });
  47. t.test('stringifies a nested array value with dots notation', function (st) {
  48. st.equal(qs.stringify({ a: { b: ['c', 'd'] } }, { allowDots: true, encode: false }), 'a.b[0]=c&a.b[1]=d');
  49. st.end();
  50. });
  51. t.test('stringifies an object inside an array', function (st) {
  52. st.equal(qs.stringify({ a: [{ b: 'c' }] }), 'a%5B0%5D%5Bb%5D=c');
  53. st.equal(qs.stringify({ a: [{ b: { c: [1] } }] }), 'a%5B0%5D%5Bb%5D%5Bc%5D%5B0%5D=1');
  54. st.end();
  55. });
  56. t.test('stringifies an array with mixed objects and primitives', function (st) {
  57. st.equal(qs.stringify({ a: [{ b: 1 }, 2, 3] }, { encode: false }), 'a[0][b]=1&a[1]=2&a[2]=3');
  58. st.end();
  59. });
  60. t.test('stringifies an object inside an array with dots notation', function (st) {
  61. st.equal(qs.stringify({ a: [{ b: 'c' }] }, { allowDots: true, encode: false }), 'a[0].b=c');
  62. st.equal(qs.stringify({ a: [{ b: { c: [1] } }] }, { allowDots: true, encode: false }), 'a[0].b.c[0]=1');
  63. st.end();
  64. });
  65. t.test('does not omit object keys when indices = false', function (st) {
  66. st.equal(qs.stringify({ a: [{ b: 'c' }] }, { indices: false }), 'a%5Bb%5D=c');
  67. st.end();
  68. });
  69. t.test('uses indices notation for arrays when indices=true', function (st) {
  70. st.equal(qs.stringify({ a: ['b', 'c'] }, { indices: true }), 'a%5B0%5D=b&a%5B1%5D=c');
  71. st.end();
  72. });
  73. t.test('uses indices notation for arrays when no arrayFormat is specified', function (st) {
  74. st.equal(qs.stringify({ a: ['b', 'c'] }), 'a%5B0%5D=b&a%5B1%5D=c');
  75. st.end();
  76. });
  77. t.test('uses indices notation for arrays when no arrayFormat=indices', function (st) {
  78. st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'indices' }), 'a%5B0%5D=b&a%5B1%5D=c');
  79. st.end();
  80. });
  81. t.test('uses repeat notation for arrays when no arrayFormat=repeat', function (st) {
  82. st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'repeat' }), 'a=b&a=c');
  83. st.end();
  84. });
  85. t.test('uses brackets notation for arrays when no arrayFormat=brackets', function (st) {
  86. st.equal(qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'brackets' }), 'a%5B%5D=b&a%5B%5D=c');
  87. st.end();
  88. });
  89. t.test('stringifies a complicated object', function (st) {
  90. st.equal(qs.stringify({ a: { b: 'c', d: 'e' } }), 'a%5Bb%5D=c&a%5Bd%5D=e');
  91. st.end();
  92. });
  93. t.test('stringifies an empty value', function (st) {
  94. st.equal(qs.stringify({ a: '' }), 'a=');
  95. st.equal(qs.stringify({ a: null }, { strictNullHandling: true }), 'a');
  96. st.equal(qs.stringify({ a: '', b: '' }), 'a=&b=');
  97. st.equal(qs.stringify({ a: null, b: '' }, { strictNullHandling: true }), 'a&b=');
  98. st.equal(qs.stringify({ a: { b: '' } }), 'a%5Bb%5D=');
  99. st.equal(qs.stringify({ a: { b: null } }, { strictNullHandling: true }), 'a%5Bb%5D');
  100. st.equal(qs.stringify({ a: { b: null } }, { strictNullHandling: false }), 'a%5Bb%5D=');
  101. st.end();
  102. });
  103. t.test('stringifies an empty object', function (st) {
  104. var obj = Object.create(null);
  105. obj.a = 'b';
  106. st.equal(qs.stringify(obj), 'a=b');
  107. st.end();
  108. });
  109. t.test('returns an empty string for invalid input', function (st) {
  110. st.equal(qs.stringify(undefined), '');
  111. st.equal(qs.stringify(false), '');
  112. st.equal(qs.stringify(null), '');
  113. st.equal(qs.stringify(''), '');
  114. st.end();
  115. });
  116. t.test('stringifies an object with an empty object as a child', function (st) {
  117. var obj = {
  118. a: Object.create(null)
  119. };
  120. obj.a.b = 'c';
  121. st.equal(qs.stringify(obj), 'a%5Bb%5D=c');
  122. st.end();
  123. });
  124. t.test('drops keys with a value of undefined', function (st) {
  125. st.equal(qs.stringify({ a: undefined }), '');
  126. st.equal(qs.stringify({ a: { b: undefined, c: null } }, { strictNullHandling: true }), 'a%5Bc%5D');
  127. st.equal(qs.stringify({ a: { b: undefined, c: null } }, { strictNullHandling: false }), 'a%5Bc%5D=');
  128. st.equal(qs.stringify({ a: { b: undefined, c: '' } }), 'a%5Bc%5D=');
  129. st.end();
  130. });
  131. t.test('url encodes values', function (st) {
  132. st.equal(qs.stringify({ a: 'b c' }), 'a=b%20c');
  133. st.end();
  134. });
  135. t.test('stringifies a date', function (st) {
  136. var now = new Date();
  137. var str = 'a=' + encodeURIComponent(now.toISOString());
  138. st.equal(qs.stringify({ a: now }), str);
  139. st.end();
  140. });
  141. t.test('stringifies the weird object from qs', function (st) {
  142. 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');
  143. st.end();
  144. });
  145. t.test('skips properties that are part of the object prototype', function (st) {
  146. Object.prototype.crash = 'test';
  147. st.equal(qs.stringify({ a: 'b' }), 'a=b');
  148. st.equal(qs.stringify({ a: { b: 'c' } }), 'a%5Bb%5D=c');
  149. delete Object.prototype.crash;
  150. st.end();
  151. });
  152. t.test('stringifies boolean values', function (st) {
  153. st.equal(qs.stringify({ a: true }), 'a=true');
  154. st.equal(qs.stringify({ a: { b: true } }), 'a%5Bb%5D=true');
  155. st.equal(qs.stringify({ b: false }), 'b=false');
  156. st.equal(qs.stringify({ b: { c: false } }), 'b%5Bc%5D=false');
  157. st.end();
  158. });
  159. t.test('stringifies buffer values', function (st) {
  160. st.equal(qs.stringify({ a: new Buffer('test') }), 'a=test');
  161. st.equal(qs.stringify({ a: { b: new Buffer('test') } }), 'a%5Bb%5D=test');
  162. st.end();
  163. });
  164. t.test('stringifies an object using an alternative delimiter', function (st) {
  165. st.equal(qs.stringify({ a: 'b', c: 'd' }, { delimiter: ';' }), 'a=b;c=d');
  166. st.end();
  167. });
  168. t.test('doesn\'t blow up when Buffer global is missing', function (st) {
  169. var tempBuffer = global.Buffer;
  170. delete global.Buffer;
  171. var result = qs.stringify({ a: 'b', c: 'd' });
  172. global.Buffer = tempBuffer;
  173. st.equal(result, 'a=b&c=d');
  174. st.end();
  175. });
  176. t.test('selects properties when filter=array', function (st) {
  177. st.equal(qs.stringify({ a: 'b' }, { filter: ['a'] }), 'a=b');
  178. st.equal(qs.stringify({ a: 1 }, { filter: [] }), '');
  179. st.equal(qs.stringify({ a: { b: [1, 2, 3, 4], c: 'd' }, c: 'f' }, { filter: ['a', 'b', 0, 2] }), 'a%5Bb%5D%5B0%5D=1&a%5Bb%5D%5B2%5D=3');
  180. st.end();
  181. });
  182. t.test('supports custom representations when filter=function', function (st) {
  183. var calls = 0;
  184. var obj = { a: 'b', c: 'd', e: { f: new Date(1257894000000) } };
  185. var filterFunc = function (prefix, value) {
  186. calls++;
  187. if (calls === 1) {
  188. st.equal(prefix, '', 'prefix is empty');
  189. st.equal(value, obj);
  190. } else if (prefix === 'c') {
  191. return;
  192. } else if (value instanceof Date) {
  193. st.equal(prefix, 'e[f]');
  194. return value.getTime();
  195. }
  196. return value;
  197. };
  198. st.equal(qs.stringify(obj, { filter: filterFunc }), 'a=b&e%5Bf%5D=1257894000000');
  199. st.equal(calls, 5);
  200. st.end();
  201. });
  202. t.test('can disable uri encoding', function (st) {
  203. st.equal(qs.stringify({ a: 'b' }, { encode: false }), 'a=b');
  204. st.equal(qs.stringify({ a: { b: 'c' } }, { encode: false }), 'a[b]=c');
  205. st.equal(qs.stringify({ a: 'b', c: null }, { strictNullHandling: true, encode: false }), 'a=b&c');
  206. st.end();
  207. });
  208. t.test('can sort the keys', function (st) {
  209. var sort = function (a, b) { return a.localeCompare(b); };
  210. st.equal(qs.stringify({ a: 'c', z: 'y', b: 'f' }, { sort: sort }), 'a=c&b=f&z=y');
  211. 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');
  212. st.end();
  213. });
  214. t.test('can sort the keys at depth 3 or more too', function (st) {
  215. var sort = function (a, b) { return a.localeCompare(b); };
  216. st.equal(qs.stringify({ a: 'a', z: { zj: {zjb: 'zjb', zja: 'zja'}, zi: {zib: 'zib', zia: 'zia'} }, b: 'b' }, { sort: sort, encode: false }), 'a=a&b=b&z[zi][zia]=zia&z[zi][zib]=zib&z[zj][zja]=zja&z[zj][zjb]=zjb');
  217. st.equal(qs.stringify({ a: 'a', z: { zj: {zjb: 'zjb', zja: 'zja'}, zi: {zib: 'zib', zia: 'zia'} }, b: 'b' }, { sort: null, encode: false }), 'a=a&z[zj][zjb]=zjb&z[zj][zja]=zja&z[zi][zib]=zib&z[zi][zia]=zia&b=b');
  218. st.end();
  219. });
  220. t.test('can stringify with custom encoding', function (st) {
  221. st.equal(qs.stringify({ 県: '大阪府', '': ''}, {
  222. encoder: function (str) {
  223. if (str.length === 0) {
  224. return '';
  225. }
  226. var buf = iconv.encode(str, 'shiftjis');
  227. var result = [];
  228. for (var i=0; i < buf.length; ++i) {
  229. result.push(buf.readUInt8(i).toString(16));
  230. }
  231. return '%' + result.join('%');
  232. }
  233. }), '%8c%a7=%91%e5%8d%e3%95%7b&=');
  234. st.end();
  235. });
  236. t.test('throws error with wrong encoder', function (st) {
  237. st.throws(function () {
  238. qs.stringify({}, {
  239. encoder: 'string'
  240. });
  241. }, new TypeError('Encoder has to be a function.'));
  242. st.end();
  243. });
  244. t.test('can use custom encoder for a buffer object', {
  245. skip: typeof Buffer === 'undefined'
  246. }, function (st) {
  247. st.equal(qs.stringify({ a: new Buffer([1]) }, {
  248. encoder: function (buffer) {
  249. if (typeof buffer === 'string') {
  250. return buffer;
  251. }
  252. return String.fromCharCode(buffer.readUInt8(0) + 97);
  253. }
  254. }), 'a=b');
  255. st.end();
  256. });
  257. });