Add enabled flag to string.trim()

resolves #1525
hapijs · Jun 23, 2018 · 77012b2 · 77012b2
1 parent 8eefd0d
commit 77012b2
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 9 deletions.
diff --git a/lib/types/string/index.js b/lib/types/string/index.js
@@ -529,20 +529,28 @@ internals.String = class extends Any {
         return obj;
     }
 
-    trim() {
+    trim(enabled) {
 
-        const obj = this._test('trim', undefined, function (value, state, options) {
+        enabled = enabled === undefined ? true : !!enabled;
+        let obj;
+        if (enabled) {
+            obj = this._test('trim', undefined, function (value, state, options) {
 
-            if (options.convert ||
-                value === value.trim()) {
+                if (options.convert ||
+                    value === value.trim()) {
 
-                return value;
-            }
+                    return value;
+                }
 
-            return this.createError('string.trim', { value }, state, options);
-        });
+                return this.createError('string.trim', { value }, state, options);
+            });
+        }
+        else {
+            obj = this.clone();
+            obj._tests = obj._tests.filter((test) => test.name !== 'trim');
+        }
 
-        obj._flags.trim = true;
+        obj._flags.trim = enabled;
         return obj;
     }
 

diff --git a/test/types/string.js b/test/types/string.js
@@ -1531,6 +1531,18 @@ describe('string', () => {
             ], { convert: false });
         });
 
+        it('disable existing trim flag when passing enabled: false', () => {
+
+            const schema = Joi.string().trim().trim(false);
+            Helper.validateOptions(schema, [
+                [' something', true],
+                ['something ', true],
+                ['something\n', true],
+                ['some thing', true],
+                ['something', true]
+            ], { convert: false });
+        });
+
         it('removes leading and trailing whitespace before validation', async () => {
 
             const schema = Joi.string().trim();