Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new AnyOf assert to validator.js-asserts to allow validating that a value matches at least one of multiple constraint sets (similar to existing OneOf, but allowing multiple matches).
Changes:
- Introduced
AnyOfassert implementation that short-circuits on first matching constraint set and aggregates violations otherwise. - Exported
AnyOffrom the library entrypoint and updated the exported-asserts ordering/count test. - Added TypeScript typings and a dedicated test suite for
AnyOf.
Reviewed changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| test/index.test.js | Updates exported asserts count and expected ordering to include AnyOf. |
| test/asserts/any-of-assert.test.js | Adds comprehensive tests for AnyOf behavior and violation reporting. |
| src/types/index.d.ts | Adds TS typing for anyOf(...constraintSets) on the asserts interface. |
| src/index.js | Exports the new AnyOf assert in stable alphabetical order. |
| src/asserts/any-of-assert.js | Implements the new AnyOf assert using validator.validate with deepRequired. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
cristianooliveira
left a comment
There was a problem hiding this comment.
Update the README
ffc4601 to
76221ba
Compare
80183db to
c488d6c
Compare
76221ba to
ea44b70
Compare
c488d6c to
5878602
Compare
ea44b70 to
cca021b
Compare
5878602 to
39fab7e
Compare
cca021b to
039afc7
Compare
39fab7e to
c8af1a3
Compare
039afc7 to
4f96195
Compare
c8af1a3 to
ced70bf
Compare
4f96195 to
6a7d98b
Compare
ced70bf to
819a49c
Compare
6a7d98b to
2fbe1f3
Compare
819a49c to
d7c2806
Compare
| this.validator = new Validator(); | ||
|
|
||
| /** | ||
| * Validation algorithm. | ||
| */ | ||
|
|
||
| this.validate = value => { | ||
| const violations = []; | ||
|
|
||
| for (const constraintSet of constraintSets) { | ||
| const result = this.validator.validate(value, new Constraint(constraintSet, { deepRequired: true })); |
There was a problem hiding this comment.
| this.validator = new Validator(); | |
| /** | |
| * Validation algorithm. | |
| */ | |
| this.validate = value => { | |
| const violations = []; | |
| for (const constraintSet of constraintSets) { | |
| const result = this.validator.validate(value, new Constraint(constraintSet, { deepRequired: true })); | |
| /** | |
| * Validation algorithm. | |
| */ | |
| this.validate = value => { | |
| const violations = []; | |
| for (const constraintSet of constraintSets) { | |
| const result = constraintSet.validate(value, new Constraint(constraintSet, { deepRequired: true })); |
From my point of view, I’d use it like this, just a dummy example:
validate(someObject, {
foobar: is.anyOf(is.ofLength({ max: 254 }), is.ofLength({ min: 10 }))
})So if I’m seeding an instance of is.ofLength({ max: 254 }) into the constraints set, this method returns an object that has a validate method, so no need to redeclare new Validator(); everytime we want to do any of.
I should be able to call it directly like this, right? is.ofLength({ max: 254 }).validate(value);
Add new assert to allow any of constraints (1 or more matches)
Added this here because https://github.com/uphold/paypal-client/pull/60 required this type of validation to have more readable code