Skip to content

根据 dva model 的类型定义进行 state、dispatch 的 TS 类型推导。传入 model 类型定义,返回 state 和 actions 的类型定义。

License

Notifications You must be signed in to change notification settings

lei4519/dva-type

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dva-type

安装

npm i dva-type —save-dev

说明

基于 TypeScript 4.1 版本的 Template Literal Types 特性,实现 dva models 的完整类型推导和提示。

传入项目的 models 类型定义,返回 stateactions的类型定义。

  • state 类型提示

image-20210607180531500

  • action type 类型提示

image-20210607180644700

  • action payload 类型推断

image-20210607181637266

使用

Example

  1. 定义单个 Model 类型(注意 ModelEffect 不是从 dva 中导入的)

    import { Effect, Model } from 'dva-type'
    
    interface ListModel extends Model {
      state: {
        list: any[]
      }
      effects: {
        // 定义effect 传入 payload 类型
        getList: Effect<number>
    
        // 不需要 payload 的 effect
        getInfo: Effect
      }
    }
  2. 定义项目中所有 Model 的集合(使用 type 而不是 interface

    // 使用 type 定义 models,将项目中的所有 model 进行收集
    type Models = {
      list: ListModel
      info: InfoModel
      // ...
    }
  3. Models 传入 ResolverModels 获取 stateactions 的类型

    import { ResolverModels } from 'dva-type'
    
    type State = ResolverModels<Models>['state']
    type Actions = ResolverModels<Models>['actions']
  4. 使用

    // hooks
    useSelector<State>()
    const dispatch = useDispatch<(action: Actions) => any>()
    
    // class
    const mapStateToProps = (state: State) => {}
    interface Props {
      dispatch: (action: Actions) => any
    }

About

根据 dva model 的类型定义进行 state、dispatch 的 TS 类型推导。传入 model 类型定义,返回 state 和 actions 的类型定义。

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published