Skipping blank values at stringify

ljharb · Apr 12, 2019 · 01d7117 · 01d7117
1 parent da6d249
commit 01d7117
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -515,6 +515,13 @@ var nullsSkipped = qs.stringify({ a: 'b', c: null}, { skipNulls: true });
 assert.equal(nullsSkipped, 'a=b');
 ```
 
+To completely skip rendering key with `blank` values ('', '  '), use the `skipBlanks` flag:
+
+```javascript
+var blanksSkipped = qs.stringify({ a: 'b', c: '', d: '  '}, { skipBlanks: true });
+assert.equal(blanksSkipped, 'a=b');
+```
+
 If you're communicating with legacy systems, you can switch to `iso-8859-1`
 using the `charset` option:
 

diff --git a/lib/stringify.js b/lib/stringify.js
@@ -42,6 +42,7 @@ var defaults = {
     serializeDate: function serializeDate(date) {
         return toISO.call(date);
     },
+    skipBlanks: false,
     skipNulls: false,
     strictNullHandling: false
 };
@@ -59,6 +60,7 @@ var stringify = function stringify(
     prefix,
     generateArrayPrefix,
     strictNullHandling,
+    skipBlanks,
     skipNulls,
     encoder,
     filter,
@@ -125,6 +127,10 @@ var stringify = function stringify(
             continue;
         }
 
+        if (skipBlanks && String(obj[key]).trim() === '') {
+            continue;
+        }
+
         var keyPrefix = isArray(obj)
             ? typeof generateArrayPrefix === 'function' ? generateArrayPrefix(prefix, key) : prefix
             : prefix + (allowDots ? '.' + key : '[' + key + ']');
@@ -134,6 +140,7 @@ var stringify = function stringify(
             keyPrefix,
             generateArrayPrefix,
             strictNullHandling,
+            skipBlanks,
             skipNulls,
             encoder,
             filter,
@@ -191,6 +198,7 @@ var normalizeStringifyOptions = function normalizeStringifyOptions(opts) {
         format: format,
         formatter: formatter,
         serializeDate: typeof opts.serializeDate === 'function' ? opts.serializeDate : defaults.serializeDate,
+        skipBlanks: typeof opts.skipBlanks === 'boolean' ? opts.skipBlanks : defaults.skipBlanks,
         skipNulls: typeof opts.skipNulls === 'boolean' ? opts.skipNulls : defaults.skipNulls,
         sort: typeof opts.sort === 'function' ? opts.sort : null,
         strictNullHandling: typeof opts.strictNullHandling === 'boolean' ? opts.strictNullHandling : defaults.strictNullHandling
@@ -243,11 +251,16 @@ module.exports = function (object, opts) {
         if (options.skipNulls && obj[key] === null) {
             continue;
         }
+
+        if (options.skipBlanks && String(obj[key]).trim() === '') {
+            continue;
+        }
         pushToArray(keys, stringify(
             obj[key],
             key,
             generateArrayPrefix,
             options.strictNullHandling,
+            options.skipBlanks,
             options.skipNulls,
             options.encode ? options.encoder : null,
             options.filter,

diff --git a/test/stringify.js b/test/stringify.js
@@ -126,6 +126,16 @@ test('stringify()', function (t) {
         st.end();
     });
 
+    t.test('omits blanks when asked', function (st) {
+        st.equal(qs.stringify({ a: 'b', c: '', d: '  ' }, { skipBlanks: true }), 'a=b');
+        st.end();
+    });
+
+    t.test('omits nested blanks when asked', function (st) {
+        st.equal(qs.stringify({ a: { b: 'c', d: '' } }, { skipBlanks: true }), 'a%5Bb%5D=c');
+        st.end();
+    });
+
     t.test('omits array indices when asked', function (st) {
         st.equal(qs.stringify({ a: ['b', 'c', 'd'] }, { indices: false }), 'a=b&a=c&a=d');
         st.end();