docs: Clarify return value of mixed.test #1089
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
Context: While it may seem obvious to many, I've previously found myself searching the docs more than once for whether or not I wanted to return `true` or `false` in `mixed.test` validators. This is a minor change to the README that clarifies the return value. Additional Details: Cleaned up some long lines and capitalized the beginning of each paragraph
mattclough1
reviewed
Nov 17, 2020
| @@ -720,7 +720,10 @@ await schema.isValid('jimmy'); // => true | |||
| await schema.isValid('john'); // => false | |||
| ``` | |||
|
|
|||
| test functions are called with a special context, or `this` value, that exposes some useful metadata and functions. Older versions just expose the `this` context using `function ()`, not arrow-func, but now it's exposed too as a second argument of the test functions. It's allow you decide which approach you prefer. | |||
| Test functions are called with a special context, or `this` value, that exposes some useful metadata | |||
| and functions. Older versions just expose the `this` context using `function ()`, not arrow-func, | |||
There was a problem hiding this comment.
Is this true for the current release?
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.
Context
While it may seem obvious to many, I've previously found myself searching the docs more than once for
whether or not I wanted to return
trueorfalseinmixed.testvalidators. This is a minor change tothe README that clarifies the return value.
Additional Details
Cleaned up some long lines and capitalized the beginning of each paragraph