aleph1.co.uk Git - yaffs-website/blob - node_modules/uncss/node_modules/qs/README.md

   1 # qs
   2
   3 A querystring parsing and stringifying library with some added security.
   4
   5 [![Build Status](https://api.travis-ci.org/ljharb/qs.svg)](http://travis-ci.org/ljharb/qs)
   6
   7 Lead Maintainer: [Jordan Harband](https://github.com/ljharb)
   8
   9 The **qs** module was originally created and maintained by [TJ Holowaychuk](https://github.com/visionmedia/node-querystring).
  10
  11 ## Usage
  12
  13 ```javascript
  14 var qs = require('qs');
  15 var assert = require('assert');
  16
  17 var obj = qs.parse('a=c');
  18 assert.deepEqual(obj, { a: 'c' });
  19
  20 var str = qs.stringify(obj);
  21 assert.equal(str, 'a=c');
  22 ```
  23
  24 ### Parsing Objects
  25
  26 [](#preventEval)
  27 ```javascript
  28 qs.parse(string, [options]);
  29 ```
  30
  31 **qs** allows you to create nested objects within your query strings, by surrounding the name of sub-keys with square brackets `[]`.
  32 For example, the string `'foo[bar]=baz'` converts to:
  33
  34 ```javascript
  35 assert.deepEqual(qs.parse('foo[bar]=baz'), {
  36   foo: {
  37     bar: 'baz'
  38   }
  39 });
  40 ```
  41
  42 When using the `plainObjects` option the parsed value is returned as a plain object, created via `Object.create(null)` and as such you should be aware that prototype methods will not exist on it and a user may set those names to whatever value they like:
  43
  44 ```javascript
  45 var plainObject = qs.parse('a[hasOwnProperty]=b', { plainObjects: true });
  46 assert.deepEqual(plainObject, { a: { hasOwnProperty: 'b' } });
  47 ```
  48
  49 By default parameters that would overwrite properties on the object prototype are ignored, if you wish to keep the data from those fields either use `plainObjects` as mentioned above, or set `allowPrototypes` to `true` which will allow user input to overwrite those properties. *WARNING* It is generally a bad idea to enable this option as it can cause problems when attempting to use the properties that have been overwritten. Always be careful with this option.
  50
  51 ```javascript
  52 var protoObject = qs.parse('a[hasOwnProperty]=b', { allowPrototypes: true });
  53 assert.deepEqual(protoObject, { a: { hasOwnProperty: 'b' } });
  54 ```
  55
  56 URI encoded strings work too:
  57
  58 ```javascript
  59 assert.deepEqual(qs.parse('a%5Bb%5D=c'), {
  60   a: { b: 'c' }
  61 });
  62 ```
  63
  64 You can also nest your objects, like `'foo[bar][baz]=foobarbaz'`:
  65
  66 ```javascript
  67 assert.deepEqual(qs.parse('foo[bar][baz]=foobarbaz'), {
  68   foo: {
  69     bar: {
  70       baz: 'foobarbaz'
  71     }
  72   }
  73 });
  74 ```
  75
  76 By default, when nesting objects **qs** will only parse up to 5 children deep. This means if you attempt to parse a string like
  77 `'a[b][c][d][e][f][g][h][i]=j'` your resulting object will be:
  78
  79 ```javascript
  80 var expected = {
  81   a: {
  82     b: {
  83       c: {
  84         d: {
  85           e: {
  86             f: {
  87               '[g][h][i]': 'j'
  88             }
  89           }
  90         }
  91       }
  92     }
  93   }
  94 };
  95 var string = 'a[b][c][d][e][f][g][h][i]=j';
  96 assert.deepEqual(qs.parse(string), expected);
  97 ```
  98
  99 This depth can be overridden by passing a `depth` option to `qs.parse(string, [options])`:
 100
 101 ```javascript
 102 var deep = qs.parse('a[b][c][d][e][f][g][h][i]=j', { depth: 1 });
 103 assert.deepEqual(deep, { a: { b: { '[c][d][e][f][g][h][i]': 'j' } } });
 104 ```
 105
 106 The depth limit helps mitigate abuse when **qs** is used to parse user input, and it is recommended to keep it a reasonably small number.
 107
 108 For similar reasons, by default **qs** will only parse up to 1000 parameters. This can be overridden by passing a `parameterLimit` option:
 109
 110 ```javascript
 111 var limited = qs.parse('a=b&c=d', { parameterLimit: 1 });
 112 assert.deepEqual(limited, { a: 'b' });
 113 ```
 114
 115 An optional delimiter can also be passed:
 116
 117 ```javascript
 118 var delimited = qs.parse('a=b;c=d', { delimiter: ';' });
 119 assert.deepEqual(delimited, { a: 'b', c: 'd' });
 120 ```
 121
 122 Delimiters can be a regular expression too:
 123
 124 ```javascript
 125 var regexed = qs.parse('a=b;c=d,e=f', { delimiter: /[;,]/ });
 126 assert.deepEqual(regexed, { a: 'b', c: 'd', e: 'f' });
 127 ```
 128
 129 Option `allowDots` can be used to enable dot notation:
 130
 131 ```javascript
 132 var withDots = qs.parse('a.b=c', { allowDots: true });
 133 assert.deepEqual(withDots, { a: { b: 'c' } });
 134 ```
 135
 136 ### Parsing Arrays
 137
 138 **qs** can also parse arrays using a similar `[]` notation:
 139
 140 ```javascript
 141 var withArray = qs.parse('a[]=b&a[]=c');
 142 assert.deepEqual(withArray, { a: ['b', 'c'] });
 143 ```
 144
 145 You may specify an index as well:
 146
 147 ```javascript
 148 var withIndexes = qs.parse('a[1]=c&a[0]=b');
 149 assert.deepEqual(withIndexes, { a: ['b', 'c'] });
 150 ```
 151
 152 Note that the only difference between an index in an array and a key in an object is that the value between the brackets must be a number
 153 to create an array. When creating arrays with specific indices, **qs** will compact a sparse array to only the existing values preserving
 154 their order:
 155
 156 ```javascript
 157 var noSparse = qs.parse('a[1]=b&a[15]=c');
 158 assert.deepEqual(noSparse, { a: ['b', 'c'] });
 159 ```
 160
 161 Note that an empty string is also a value, and will be preserved:
 162
 163 ```javascript
 164 var withEmptyString = qs.parse('a[]=&a[]=b');
 165 assert.deepEqual(withEmptyString, { a: ['', 'b'] });
 166
 167 var withIndexedEmptyString = qs.parse('a[0]=b&a[1]=&a[2]=c');
 168 assert.deepEqual(withIndexedEmptyString, { a: ['b', '', 'c'] });
 169 ```
 170
 171 **qs** will also limit specifying indices in an array to a maximum index of `20`. Any array members with an index of greater than `20` will
 172 instead be converted to an object with the index as the key:
 173
 174 ```javascript
 175 var withMaxIndex = qs.parse('a[100]=b');
 176 assert.deepEqual(withMaxIndex, { a: { '100': 'b' } });
 177 ```
 178
 179 This limit can be overridden by passing an `arrayLimit` option:
 180
 181 ```javascript
 182 var withArrayLimit = qs.parse('a[1]=b', { arrayLimit: 0 });
 183 assert.deepEqual(withArrayLimit, { a: { '1': 'b' } });
 184 ```
 185
 186 To disable array parsing entirely, set `parseArrays` to `false`.
 187
 188 ```javascript
 189 var noParsingArrays = qs.parse('a[]=b', { parseArrays: false });
 190 assert.deepEqual(noParsingArrays, { a: { '0': 'b' } });
 191 ```
 192
 193 If you mix notations, **qs** will merge the two items into an object:
 194
 195 ```javascript
 196 var mixedNotation = qs.parse('a[0]=b&a[b]=c');
 197 assert.deepEqual(mixedNotation, { a: { '0': 'b', b: 'c' } });
 198 ```
 199
 200 You can also create arrays of objects:
 201
 202 ```javascript
 203 var arraysOfObjects = qs.parse('a[][b]=c');
 204 assert.deepEqual(arraysOfObjects, { a: [{ b: 'c' }] });
 205 ```
 206
 207 ### Stringifying
 208
 209 [](#preventEval)
 210 ```javascript
 211 qs.stringify(object, [options]);
 212 ```
 213
 214 When stringifying, **qs** by default URI encodes output. Objects are stringified as you would expect:
 215
 216 ```javascript
 217 assert.equal(qs.stringify({ a: 'b' }), 'a=b');
 218 assert.equal(qs.stringify({ a: { b: 'c' } }), 'a%5Bb%5D=c');
 219 ```
 220
 221 This encoding can be disabled by setting the `encode` option to `false`:
 222
 223 ```javascript
 224 var unencoded = qs.stringify({ a: { b: 'c' } }, { encode: false });
 225 assert.equal(unencoded, 'a[b]=c');
 226 ```
 227
 228 Examples beyond this point will be shown as though the output is not URI encoded for clarity. Please note that the return values in these cases *will* be URI encoded during real usage.
 229
 230 When arrays are stringified, by default they are given explicit indices:
 231
 232 ```javascript
 233 qs.stringify({ a: ['b', 'c', 'd'] });
 234 // 'a[0]=b&a[1]=c&a[2]=d'
 235 ```
 236
 237 You may override this by setting the `indices` option to `false`:
 238
 239 ```javascript
 240 qs.stringify({ a: ['b', 'c', 'd'] }, { indices: false });
 241 // 'a=b&a=c&a=d'
 242 ```
 243
 244 You may use the `arrayFormat` option to specify the format of the output array
 245
 246 ```javascript
 247 qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'indices' })
 248 // 'a[0]=b&a[1]=c'
 249 qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'brackets' })
 250 // 'a[]=b&a[]=c'
 251 qs.stringify({ a: ['b', 'c'] }, { arrayFormat: 'repeat' })
 252 // 'a=b&a=c'
 253 ```
 254
 255 Empty strings and null values will omit the value, but the equals sign (=) remains in place:
 256
 257 ```javascript
 258 assert.equal(qs.stringify({ a: '' }), 'a=');
 259 ```
 260
 261 Properties that are set to `undefined` will be omitted entirely:
 262
 263 ```javascript
 264 assert.equal(qs.stringify({ a: null, b: undefined }), 'a=');
 265 ```
 266
 267 The delimiter may be overridden with stringify as well:
 268
 269 ```javascript
 270 assert.equal(qs.stringify({ a: 'b', c: 'd' }, { delimiter: ';' }), 'a=b;c=d');
 271 ```
 272
 273 Finally, you can use the `filter` option to restrict which keys will be included in the stringified output.
 274 If you pass a function, it will be called for each key to obtain the replacement value. Otherwise, if you
 275 pass an array, it will be used to select properties and array indices for stringification:
 276
 277 ```javascript
 278 function filterFunc(prefix, value) {
 279   if (prefix == 'b') {
 280     // Return an `undefined` value to omit a property.
 281     return;
 282   }
 283   if (prefix == 'e[f]') {
 284     return value.getTime();
 285   }
 286   if (prefix == 'e[g][0]') {
 287     return value * 2;
 288   }
 289   return value;
 290 }
 291 qs.stringify({ a: 'b', c: 'd', e: { f: new Date(123), g: [2] } }, { filter: filterFunc });
 292 // 'a=b&c=d&e[f]=123&e[g][0]=4'
 293 qs.stringify({ a: 'b', c: 'd', e: 'f' }, { filter: ['a', 'e'] });
 294 // 'a=b&e=f'
 295 qs.stringify({ a: ['b', 'c', 'd'], e: 'f' }, { filter: ['a', 0, 2] });
 296 // 'a[0]=b&a[2]=d'
 297 ```
 298
 299 ### Handling of `null` values
 300
 301 By default, `null` values are treated like empty strings:
 302
 303 ```javascript
 304 var withNull = qs.stringify({ a: null, b: '' });
 305 assert.equal(withNull, 'a=&b=');
 306 ```
 307
 308 Parsing does not distinguish between parameters with and without equal signs. Both are converted to empty strings.
 309
 310 ```javascript
 311 var equalsInsensitive = qs.parse('a&b=');
 312 assert.deepEqual(equalsInsensitive, { a: '', b: '' });
 313 ```
 314
 315 To distinguish between `null` values and empty strings use the `strictNullHandling` flag. In the result string the `null`
 316 values have no `=` sign:
 317
 318 ```javascript
 319 var strictNull = qs.stringify({ a: null, b: '' }, { strictNullHandling: true });
 320 assert.equal(strictNull, 'a&b=');
 321 ```
 322
 323 To parse values without `=` back to `null` use the `strictNullHandling` flag:
 324
 325 ```javascript
 326 var parsedStrictNull = qs.parse('a&b=', { strictNullHandling: true });
 327 assert.deepEqual(parsedStrictNull, { a: null, b: '' });
 328 ```
 329
 330 To completely skip rendering keys with `null` values, use the `skipNulls` flag:
 331
 332 ```javascript
 333 var nullsSkipped = qs.stringify({ a: 'b', c: null}, { skipNulls: true });
 334 assert.equal(nullsSkipped, 'a=b');
 335 ```