docs: update JSDoc for forbidUnknownValues

typestack · Dec 2, 2022 · e252183 · e252183
1 parent 3976453
commit e252183
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/src/validation/ValidatorOptions.ts b/src/validation/ValidatorOptions.ts
@@ -72,7 +72,12 @@ export interface ValidatorOptions {
   };
 
   /**
-   * Settings true will cause fail validation of unknown objects.
+   * Fails validation for objects unknown to class-validator. Defaults to false.
+   *
+   * For instance, since a plain empty object has no annotations used for validation:
+   * - `validate({})` // passes
+   * - `validate({}, { forbidUnknownValues: true })` // fails.
+   * - `validate(new SomeAnnotatedEmptyClass(), { forbidUnknownValues: true })` // passes.
    */
   forbidUnknownValues?: boolean;