docs(typescript): align AppThunk extra arg type with createAsyncThunk.withTypes#4873
Open
webdevelopersrinu wants to merge 1 commit into
Open
Conversation
…Types Change the 'extra argument' generic in AppThunk/ThunkAction examples from `unknown` to `undefined` so that thunks dispatched via `createAsyncThunk.withTypes` (which defaults to `undefined`) type-check correctly when called inside a handwritten thunk. Fixes reduxjs#4602
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. |
✅ Deploy Preview for redux-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
aryaemami59
changed the title
AppThunk extra arg type with createAsyncThunk.withTypes
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
2 participants
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
Aligns the
AppThunk/ThunkActionexamples in the docs and thecounter-tsexample with how Redux Toolkit'screateAsyncThunk.withTypesactually types the thunk dispatcher.
Fixes #4602
The problem
The Redux docs recommend defining
AppThunkwithunknownas theextra-argument generic. Meanwhile, RTK's
createAsyncThunk.withTypesdefaults the extra argument to
undefinedwhen noextrais provided.The result is a
ThunkDispatch<RootState, unknown, ...>vsThunkDispatch<RootState, undefined, ...>mismatch, so dispatching atyped RTK async thunk from inside a handwritten
AppThunkraises aTypeScript error.
The fix
Change the extra-argument generic from
unknowntoundefinedin thedocumented examples and in the
counter-tstemplate, so the tworecommended patterns agree.
Files changed
docs/usage/UsageWithTypescript.md—AppThunktype,ThunkActionexample, and surrounding prosedocs/tutorials/essentials/part-2-app-structure.md—AppThunktypedocs/tutorials/essentials/part-5-async-logic.md—AppThunktypeexamples/counter-ts/src/app/store.ts—AppThunktypeTotal: 6 lines across 4 files.
Testing
Docs-only / example-only changes; no runtime behavior is affected.
Relying on CI to validate the Docusaurus build and the
counter-tstypecheck.