refactor: strong type for getFormHelpers name #1029
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 Report
@@ Coverage Diff @@
## main #1029 +/- ##
==========================================
- Coverage 67.54% 67.32% -0.23%
==========================================
Files 259 259
Lines 15059 15061 +2
Branches 151 152 +1
==========================================
- Hits 10172 10140 -32
- Misses 3873 3899 +26
- Partials 1014 1022 +8
Continue to review full report at Codecov.
|
presleyp
reviewed
Apr 15, 2022
| // getIn is a util function from Formik that gets at any depth of nesting, and is necessary for the types to work | ||
| export const getFormHelpers = <T>(form: FormikContextType<T>, name: keyof T, error?: string): FormHelpers => { | ||
| if (typeof name !== "string") { | ||
| throw new Error(`name must be type of string, instead received '${typeof name}'`) |
There was a problem hiding this comment.
What happens if somehow this gets thrown in production?
There was a problem hiding this comment.
That's a desirable case at this stage. We don't yet have an error boundary ported (#1013 ), but you'd hit that.
presleyp
approved these changes
Apr 15, 2022
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.
Summary:
Modify
getFormHelpersso that only the keys of the generic form interfacecan be passed in for
name.Details:
Keys of an object in TS can naturally be of
string | number | symbol. I don't thinkthere's an easy way to re-genericize this helper and type things that gets around this,
so I took the simple path of throwing an
Errorontypeof !== "string".Impact:
Minor improvement to dev experience using
getFormHelpers(compile-time safety).