Validator#validate: add "required" option

awwright · awwright · commit 5a8649de5270 · 2020-10-19T18:44:36.000-07:00
diff --git a/lib/helpers.js b/lib/helpers.js
@@ -33,6 +33,7 @@ ValidationError.prototype.toString = function toString() {
 var ValidatorResult = exports.ValidatorResult = function ValidatorResult(instance, schema, options, ctx) {
   this.instance = instance;
   this.schema = schema;
+  this.options = options;
   this.path = ctx.path;
   this.propertyPath = ctx.propertyPath;
   this.errors = [];
diff --git a/lib/validator.js b/lib/validator.js
@@ -124,6 +124,11 @@ Validator.prototype.validate = function validate (instance, schema, options, ctx
       ctx.schemas[n] = sch;
     }
   }
+  if(options.required && instance===undefined){
+    var result = new ValidatorResult(instance, schema, options, ctx);
+    result.addError('is required, but is undefined');
+    return result;
+  }
   var result = this.validateSchema(instance, schema, options, ctx);
   if (!result) {
     throw new Error('Result undefined');
diff --git a/test/Validator.test.js b/test/Validator.test.js
@@ -154,5 +154,25 @@ describe('Validator', function () {
     it('options.base must be a string', function () {
       validator.validate(null, true, null);
     });
+    it('options.required with defined instance', function () {
+      var res = validator.validate(undefined, true, {required: true});
+      assert(!res.valid);
+      console.error(res.errors);
+      assert(res.errors[0].message.indexOf('required') >= 0);
+    });
+    it('options.required with undefined instance', function () {
+      var res = validator.validate(undefined, true, {required: true});
+      assert(!res.valid);
+      assert(res.errors[0].message.indexOf('required') >= 0);
+    });
+    it('options.required is false', function () {
+      var res = validator.validate(undefined, true, {required: false});
+      assert(res.valid);
+    });
+    it('options.required defaults false', function () {
+      // TODO DEPRECATED: this behavior changes to true in next major version
+      var res = validator.validate(undefined, true, {});
+      assert(res.valid);
+    });
   });
 });

Original file line number	Diff line number	Diff line change
`@@ -124,6 +124,11 @@ Validator.prototype.validate = function validate (instance, schema, options, ctx`
`124`	`124`	`ctx.schemas[n] = sch;`
`125`	`125`	`}`
`126`	`126`	`}`
	`127`	`+ if(options.required && instance===undefined){`
	`128`	`+ var result = new ValidatorResult(instance, schema, options, ctx);`
	`129`	`+ result.addError('is required, but is undefined');`
	`130`	`+ return result;`
	`131`	`+ }`
`127`	`132`	`var result = this.validateSchema(instance, schema, options, ctx);`
`128`	`133`	`if (!result) {`
`129`	`134`	`throw new Error('Result undefined');`