如何在 Typescript 中使用 redux-thunk 使用 ThunkAction 正确键入 thunk？

Question

我正在尝试使用 Typescript 键入检查我的redux-thunk代码。

从 Redux: Usage with Redux Thunk的官方文档中，我们得到了这个例子：

// src/thunks.ts

import { Action } from 'redux'
import { sendMessage } from './store/chat/actions'
import { RootState } from './store'
import { ThunkAction } from 'redux-thunk'

export const thunkSendMessage = (
  message: string
): ThunkAction<void, RootState, unknown, Action<string>> => async dispatch => {
  const asyncResp = await exampleAPI()
  dispatch(
    sendMessage({
      message,
      user: asyncResp,
      timestamp: new Date().getTime()
    })
  )
}

function exampleAPI() {
  return Promise.resolve('Async Chat Bot')
}

为了减少重复，您可能希望在存储文件中定义一次可重用的 AppThunk 类型，然后在编写 thunk 时使用该类型：

export type AppThunk<ReturnType = void> = ThunkAction<
  ReturnType,
  RootState,
  unknown,
  Action<string>
>

题

我不完全理解ThunkAction类型的使用：

ThunkAction<void, RootState, unknown, Action<string>>

有 4 个类型参数，对吧？

第一个- void

这是 thunk 的返回类型，对吧？ 不应该是Promise<void> ，因为它是async吗？

第二个- RootState

这是完整的状态形状，对吧？ 我的意思是，它不是切片，而是完整的状态。

第三名- unknown

为什么这是unknown ？ 这是什么？

第四个- Action<string>

这个也不懂。 为什么Action<T>将字符串作为参数？ 它应该总是string吗？ 为什么？

Answer 1

从https://github.com/reduxjs/redux-thunk/blob/d28ab03fd1d2dd1de402928a9589857e97142e09/src/index.d.ts

/**
 * A "thunk" action (a callback function that can be dispatched to the Redux
 * store.)
 *
 * Also known as the "thunk inner function", when used with the typical pattern
 * of an action creator function that returns a thunk action.
 *
 * @template TReturnType The return type of the thunk's inner function
 * @template TState The redux state
 * @template TExtraThunkARg Optional extra argument passed to the inner function
 * (if specified when setting up the Thunk middleware)
 * @template TBasicAction The (non-thunk) actions that can be dispatched.
 */
export type ThunkAction<
  TReturnType,
  TState,
  TExtraThunkArg,
  TBasicAction extends Action
> = (
  dispatch: ThunkDispatch<TState, TExtraThunkArg, TBasicAction>,
  getState: () => TState,
  extraArgument: TExtraThunkArg,
) => TReturnType;

首先- TReturnType

在这里，我们不关心返回类型——无论如何我们都不会等待 thunk 的结果。 在 TS 中，可以将任何函数分配给 void 签名，因为它不会损害类型安全。 这是一个示例，显示我可以将各种异步/非异步函数分配给 void 函数签名：

我们使用提供的 dispatch 函数来触发我们关心的下一个动作 - 所以在时间方面唯一重要的事情是在异步函数内部我们正在等待某些事情。 Redux-thunk 内部没有对这个函数的结果做任何事情。 这里有一个很好的解释器，解释了 thunk 如何在幕后工作（只需要预览）：

https://frontendmasters.com/courses/rethinking-async-js/synchronous-and-asynchronous-thunks/

第二- TState是的 - 这是整个商店状态类型

第三 - TExtraThunkARg您可以添加自己的自定义额外参数，在 dispatch 和 getState 之后传递到 thunk。 这默认为未知，因为除非您明确提供它，否则不清楚它将是什么。 这是类型安全的，因为尝试与未知参数交互将导致编译时错误。

更多信息： https : //github.com/reduxjs/redux-thunk#injecting-a-custom-argument

第四 - TBasicAction

这是一种动作类型。 动作是最基本的动作类型——其中每个type属性都是一个纯字符串。 您可以选择提供自己的更具体的类型 - 即type MyActionType = 'FOO_ACTION' | 'BAR_ACTION' type MyActionType = 'FOO_ACTION' | 'BAR_ACTION'用于进一步类型安全/缩小。 然后您将使用它作为操作。

Answer 2

实际上，大部分答案都可以在源代码中找到。

 * @template TReturnType The return type of the thunk's inner function
 * @template TState The redux state
 * @template TExtraThunkARg Optional extra argument passed to the inner function
 * (if specified when setting up the Thunk middleware)
 * @template TBasicAction The (non-thunk) actions that can be dispatched.
 */
export type ThunkAction<
  TReturnType,
  TState,
  TExtraThunkArg,
  TBasicAction extends Action
> = (
  dispatch: ThunkDispatch<TState, TExtraThunkArg, TBasicAction>,
  getState: () => TState,
  extraArgument: TExtraThunkArg,
) => TReturnType;

第一个- void

thunk 的返回类型不是Promise 。 它只是一个返回内部函数的函数。 由于内部函数不返回任何内容，因此返回类型为void 。

第二个- RootState

对，那是正确的。 参考上面的源代码。 具体来说，这一行* @template TState The redux state 。

第三名- unknown

你在这里读到了未知。

第四个- Action<string>

参考这一行* @template TBasicAction The (non-thunk) actions that can be dispatched.

 * @template T the type of the action's `type` tag.
 */
export interface Action<T = any> {
  type: T
}

代码片段是从这里提取的。

Action<T>接受string类型，因为操作类型是一个string ，而ThunkAction类型需要一个Action类型，如下所示 - TBasicAction extends Action 。

更正

第一个- void

我误解并忘记了async函数。 请参阅下面的第一条评论。