feat!: typed validators #118
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #118 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 16 18 +2
Lines 3921 4182 +261
Branches 638 659 +21
==========================================
+ Hits 3921 4182 +261
|
ssaarela
force-pushed
the
f/result-typing
branch
from
94f6a79 to
f51a1ba
Compare
Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
* initial object type builder * number & string validator chaining Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
ssaarela
force-pushed
the
f/result-typing
branch
from
57f4db9 to
e85ed72
Compare
Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
finnair-jw
approved these changes
Nov 5, 2024
There was a problem hiding this comment.
Typing the existing validators is a large effort. This approach seems quite reasonable. Getting it to this point and releasing it as a beta version was a good idea.
As a general comment for the next updates, in a lot of cases the validators are still using any for the input value. unknown would behave the same way for the caller, and be much safer inside the validator function.
Breaking change: V.number() does not support Number object any more Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
* ObjectValidators parent next validators as allOf * V.array, V.if and V.whenGroup validators with multiple (compositionOf) item validators Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
…lidationResult wrapper * Validator#validatePath either returns Promise.resolve(value) or reject with violation(s) * This allows better type inference as failure case doesn't mix with success case Signed-off-by: Samppa Saarela <samppa.saarela@iki.fi>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New Features
V.objectType()builder can be used to build an ObjectValidator with inferred type.VType<typeof validator>.V.number().min(1).max(2)):V.string()supportsnotEmpty,notBlankandpattern.V.number()supportsminandmax.Breaking changes:
V.optional,V.required,V.check,V.if,V.whenGroup,V.jsonandObjectModel#next) are combined usingV.compositionOfinstead ofV.allOfas composition makes more sense in general. However, if there are multiple parents with next validators, those are still combined withV.allOfas they are not aware of each other.