www.aleph1.co.uk Git - yaffs-website/blob - node_modules/qs/lib/stringify.js

   1 'use strict';
   2
   3 var utils = require('./utils');
   4 var formats = require('./formats');
   5
   6 var arrayPrefixGenerators = {
   7     brackets: function brackets(prefix) { // eslint-disable-line func-name-matching
   8         return prefix + '[]';
   9     },
  10     indices: function indices(prefix, key) { // eslint-disable-line func-name-matching
  11         return prefix + '[' + key + ']';
  12     },
  13     repeat: function repeat(prefix) { // eslint-disable-line func-name-matching
  14         return prefix;
  15     }
  16 };
  17
  18 var toISO = Date.prototype.toISOString;
  19
  20 var defaults = {
  21     delimiter: '&',
  22     encode: true,
  23     encoder: utils.encode,
  24     serializeDate: function serializeDate(date) { // eslint-disable-line func-name-matching
  25         return toISO.call(date);
  26     },
  27     skipNulls: false,
  28     strictNullHandling: false
  29 };
  30
  31 var stringify = function stringify( // eslint-disable-line func-name-matching
  32     object,
  33     prefix,
  34     generateArrayPrefix,
  35     strictNullHandling,
  36     skipNulls,
  37     encoder,
  38     filter,
  39     sort,
  40     allowDots,
  41     serializeDate,
  42     formatter
  43 ) {
  44     var obj = object;
  45     if (typeof filter === 'function') {
  46         obj = filter(prefix, obj);
  47     } else if (obj instanceof Date) {
  48         obj = serializeDate(obj);
  49     } else if (obj === null) {
  50         if (strictNullHandling) {
  51             return encoder ? encoder(prefix) : prefix;
  52         }
  53
  54         obj = '';
  55     }
  56
  57     if (typeof obj === 'string' || typeof obj === 'number' || typeof obj === 'boolean' || utils.isBuffer(obj)) {
  58         if (encoder) {
  59             return [formatter(encoder(prefix)) + '=' + formatter(encoder(obj))];
  60         }
  61         return [formatter(prefix) + '=' + formatter(String(obj))];
  62     }
  63
  64     var values = [];
  65
  66     if (typeof obj === 'undefined') {
  67         return values;
  68     }
  69
  70     var objKeys;
  71     if (Array.isArray(filter)) {
  72         objKeys = filter;
  73     } else {
  74         var keys = Object.keys(obj);
  75         objKeys = sort ? keys.sort(sort) : keys;
  76     }
  77
  78     for (var i = 0; i < objKeys.length; ++i) {
  79         var key = objKeys[i];
  80
  81         if (skipNulls && obj[key] === null) {
  82             continue;
  83         }
  84
  85         if (Array.isArray(obj)) {
  86             values = values.concat(stringify(
  87                 obj[key],
  88                 generateArrayPrefix(prefix, key),
  89                 generateArrayPrefix,
  90                 strictNullHandling,
  91                 skipNulls,
  92                 encoder,
  93                 filter,
  94                 sort,
  95                 allowDots,
  96                 serializeDate,
  97                 formatter
  98             ));
  99         } else {
 100             values = values.concat(stringify(
 101                 obj[key],
 102                 prefix + (allowDots ? '.' + key : '[' + key + ']'),
 103                 generateArrayPrefix,
 104                 strictNullHandling,
 105                 skipNulls,
 106                 encoder,
 107                 filter,
 108                 sort,
 109                 allowDots,
 110                 serializeDate,
 111                 formatter
 112             ));
 113         }
 114     }
 115
 116     return values;
 117 };
 118
 119 module.exports = function (object, opts) {
 120     var obj = object;
 121     var options = opts || {};
 122
 123     if (options.encoder !== null && options.encoder !== undefined && typeof options.encoder !== 'function') {
 124         throw new TypeError('Encoder has to be a function.');
 125     }
 126
 127     var delimiter = typeof options.delimiter === 'undefined' ? defaults.delimiter : options.delimiter;
 128     var strictNullHandling = typeof options.strictNullHandling === 'boolean' ? options.strictNullHandling : defaults.strictNullHandling;
 129     var skipNulls = typeof options.skipNulls === 'boolean' ? options.skipNulls : defaults.skipNulls;
 130     var encode = typeof options.encode === 'boolean' ? options.encode : defaults.encode;
 131     var encoder = encode ? (typeof options.encoder === 'function' ? options.encoder : defaults.encoder) : null;
 132     var sort = typeof options.sort === 'function' ? options.sort : null;
 133     var allowDots = typeof options.allowDots === 'undefined' ? false : options.allowDots;
 134     var serializeDate = typeof options.serializeDate === 'function' ? options.serializeDate : defaults.serializeDate;
 135     if (typeof options.format === 'undefined') {
 136         options.format = formats.default;
 137     } else if (!Object.prototype.hasOwnProperty.call(formats.formatters, options.format)) {
 138         throw new TypeError('Unknown format option provided.');
 139     }
 140     var formatter = formats.formatters[options.format];
 141     var objKeys;
 142     var filter;
 143
 144     if (typeof options.filter === 'function') {
 145         filter = options.filter;
 146         obj = filter('', obj);
 147     } else if (Array.isArray(options.filter)) {
 148         filter = options.filter;
 149         objKeys = filter;
 150     }
 151
 152     var keys = [];
 153
 154     if (typeof obj !== 'object' || obj === null) {
 155         return '';
 156     }
 157
 158     var arrayFormat;
 159     if (options.arrayFormat in arrayPrefixGenerators) {
 160         arrayFormat = options.arrayFormat;
 161     } else if ('indices' in options) {
 162         arrayFormat = options.indices ? 'indices' : 'repeat';
 163     } else {
 164         arrayFormat = 'indices';
 165     }
 166
 167     var generateArrayPrefix = arrayPrefixGenerators[arrayFormat];
 168
 169     if (!objKeys) {
 170         objKeys = Object.keys(obj);
 171     }
 172
 173     if (sort) {
 174         objKeys.sort(sort);
 175     }
 176
 177     for (var i = 0; i < objKeys.length; ++i) {
 178         var key = objKeys[i];
 179
 180         if (skipNulls && obj[key] === null) {
 181             continue;
 182         }
 183
 184         keys = keys.concat(stringify(
 185             obj[key],
 186             key,
 187             generateArrayPrefix,
 188             strictNullHandling,
 189             skipNulls,
 190             encoder,
 191             filter,
 192             sort,
 193             allowDots,
 194             serializeDate,
 195             formatter
 196         ));
 197     }
 198
 199     return keys.join(delimiter);
 200 };