added info about addMethod for this.test() #1817
Open
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
jquense
reviewed
Oct 31, 2022
| @@ -566,6 +566,19 @@ import { addMethod, Schema } from 'yup'; | |||
| addMethod(Schema, 'myMethod', ...) | |||
| ``` | |||
|
|
|||
|
|
|||
| You can add your test methods to the schema using `addMethod` by returning `this.test()`. This will allow you to reuse them as well. | |||
There was a problem hiding this comment.
Rather than add add a new section here, let's add the code example to the first code block and then demonstrate how to use the new added methods. For extra clarity i think it's worth adding a few words about this being the the schema instance, and so any of the methods documented in the docs will be on them.
There was a problem hiding this comment.
Sure. I will make the change and resubmit.
|
Would be much better if this example was in Typescript, and included what one would need to add to the |
|
Yes a Typescript example would be very helpful. Please add one. |
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.
Updated README.md to add info about addMethod for this.test() re: #1814