Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TS conflict between AppThunk and createAsyncThunk.withTypes #4602

Open
zshuzh opened this issue Sep 21, 2023 · 2 comments
Open

TS conflict between AppThunk and createAsyncThunk.withTypes #4602

zshuzh opened this issue Sep 21, 2023 · 2 comments

Comments

@zshuzh
Copy link

zshuzh commented Sep 21, 2023

What docs page needs to be fixed?

In the Redux Docs > Usage With Typescript > Type Checking Redux Thunks, it recommends using the following to type thunks:

export type AppThunk<ReturnType = void> = ThunkAction<
  ReturnType, // return type of the thunk function
  RootState, // state type used by getState
  unknown, // any "extra argument" injected into the thunk
  UnknownAction // known types of actions that can be dispatched
>

In the RTK Docs > Usage with Typescript > Defining a Pre-Typed createAsyncThunk, it recommends the following to type createAsyncThunk:

const createAppAsyncThunk = createAsyncThunk.withTypes<{
  state: RootState
  dispatch: AppDispatch
  rejectValue: string
  extra: { s: string; n: number }
}>()

I'm using both of these in my apps, but when I try to dispatch a thunk created using createAppAsyncThunk from a regular thunk, it's flagging a type error.

What is the problem?

From what I can see, it seems the two approaches type dispatch differently. The first approach (with AppThunk) types the dispatch parameter as ThunkDispatch<RootState, unknown, UnknownAction> but the second approach (with createAsyncThunk.withTypes) types the dispatch parameter as ThunkDispatch<RootState, undefined, UnknownAction> which is causing a problem,

What should be changed to fix the problem?

I was able to fix the problem like this:

export type AppThunk<ReturnType = void> = ThunkAction<
  ReturnType,
  RootState,
  undefined, // changed this from unknown to undefined
  UnknownAction
>
@EskiMojo14
Copy link
Contributor

EskiMojo14 commented Sep 21, 2023

are you specifically providing extra: undefined as one of the keys in your ThunkApiConfig for .withTypes? if you don't provide it, it should default to unknown.

@EskiMojo14
Copy link
Contributor

TS Playground

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants