The example in hooks-faq "is-there-something-like-forceupdate" is wrong
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
Direct link: https://reactjs.org/docs/hooks-faq.html#is-there-something-like-forceupdate
The example says
const [ignored, forceUpdate] = useReducer(x => x + 1, 0);
function handleClick() {
forceUpdate();
}
But this makes typescript report an error. (The typescript types are provided by the react team itself right? otherwise I might need to file a bug with the team maintaining the types)
Possible fixes:
const [ignored, forceUpdate] = useReducer(x => x + 1, 0);
function handleClick() {
forceUpdate("something"); //I added an argument here
}
will pass the type checker
const [ignored, forceUpdate] = useState(0); //useState instead of useReducer
function handleClick() {
forceUpdate(x => x + 1); //calculate function
}
is also ok (and a bit nicer IMHO)
Contributor guide
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
Open the linked Hooks FAQ section, “Is there something like forceUpdate?”, and inspect the shown useReducer example. Verify the example with TypeScript, then update it using one of the type-checking alternatives described in the issue. Done means the documentation example no longer produces the reported TypeScript error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100