react-component / react-component/field-form
increased type safety via string literals
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1k
- Forks
- 286
- Avg merge
- 4d 16h
- Merged PRs (30d)
- 1
Description
We would get considerably better type safety out of many of the form instance functions if we used the keyof operator. For instance, this simple change would make it impossible to accidentally misspell the field that we're looking for.
export interface FormInstance<Values = any> {
getFieldValue: (name: NamePath) => StoreValue;
to this:
export interface FormInstance<Values = any> {
getFieldValue: <NamePath extends keyof FormFieldsAndValues>(name: NamePath) => FormFieldsAndValues[NamePath] | undefined;
So then if field you wanted to get was called "address" you couldn't make the mistake of typing:
form.getFieldValue("addr")
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the TypeScript definitions for FormInstance, getFieldValue, NamePath, and FormFieldsAndValues, then inspect the other form instance functions that may need the same treatment. Done means the relevant APIs reject misspelled field names and return value types derived from the form fields.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100