docs: correct setError error argument type signature#1205
Merged
bluebill1049 merged 2 commits intoreact-hook-form:masterfrom Apr 25, 2026
Merged
Conversation
Contributor
|
@dfedoryshchev is attempting to deploy a commit to the BEEKAI OSS Team on Vercel. A member of the Team first needs to authorize it. |
✅ Deploy Preview for sage-cassata-31d224 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
bluebill1049
approved these changes
Apr 25, 2026
This file contains hidden or 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
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.
The
setErrordocs describe the second argument asFieldErrorwithtypeandtypesmarked as required. Both are wrong against the library source.The argument type is
ErrorOption, notFieldError(seeUseFormSetErrorinsrc/types/form.ts:644). All three fields onErrorOptionare optional (src/types/errors.ts:21-25):FieldErroris a different type (the shape of entries onformState.errors), so the current wording also pointed at the wrong thing.Two content changes in
src/content/docs/useform/seterror.mdx: the signature line (error: FieldErrortoerror: ErrorOption) and theerrorprops row (optional markers ontypeandtypes). Prettier reflowed the table column widths; split into a second commit matching the repo's format-as-follow-up pattern.Addresses point 1 from #1065. The other points (
typesusage details, "Multiple Errors" naming, nested-merge behavior) need separate verification and are out of scope here.