Add more comment and test.

package.json

@@ -24,12 +24,6 @@
       "pre-commit": "npm run lint"
     }
   },
-  "prettier": {
-    "printWidth": 80,
-    "semi": true,
-    "singleQuote": true,
-    "trailingComma": "es5"
-  },
   "name": "dva-toolkit",
   "author": "Bay",
   "module": "dist/dva-toolkit.esm.js",

src/actions.ts

@@ -16,7 +16,7 @@ export type ActionCreatorDvaCaseReducer<R> =
     : ActionCreatorWithoutPayload
 
 /**
- * dva action need
+ * dva reducer actions creator
  *
  * @public
  */
@@ -25,7 +25,7 @@ export type ActionCreatorDvaReducers<Reducers extends DvaReducers> = {
 }
 
 /**
- * dva
+ * dva reducer actions
  *
  * @public
  */
@@ -35,13 +35,23 @@ export type DvaReducersAction<
   ? ActionCreatorDvaReducers<Reducers>
   : never
 
+/**
+ * dva effects actions creator
+ *
+ * @public
+ */
 export type ActionCreatorDvaEffect<E> =
   E extends (action: infer Action, effects: any) => any
     ? Action extends { payload: infer P }
       ? ActionCreatorWithPayload<P>
       : ActionCreatorWithoutPayload
     : ActionCreatorWithoutPayload
 
+/**
+ * dva effects actions
+ *
+ * @public
+ */
 export type DvaEffectsAction<
   CE extends DvaSliceCaseEffects
 > = {
@@ -50,6 +60,11 @@ export type DvaEffectsAction<
     : ActionCreatorDvaEffect<CE[Type]>
 }
 
+/**
+ * dva actions
+ *
+ * @public
+ */
 export type DvaCaseAction<
   CR extends DvaSliceCaseReducers<any>,
   CE extends DvaSliceCaseEffects

src/effects.ts

@@ -3,7 +3,7 @@ import type { call, put, take, select, cancel } from 'redux-saga/effects'
 import type { PayloadAction } from '@reduxjs/toolkit'
 
 /**
- * dva 支持的 saga command 列表
+ * saga effects supported by dva
  *
  * @public
  */
@@ -17,25 +17,30 @@ export type SagaEffectsCommandMap = {
 }
 
 /**
- * effect 方法
+ * pure effect method
  *
  * @public
  */
 export type DvaCaseEffects =
   (action: PayloadAction<any>, effects: SagaEffectsCommandMap) => Generator
 
 /**
- * 有 effect 类型的 effect 方法
+ * effect with saga config
  *
  * @public
  */
 export type DvaCaseEffectWithType =
   [DvaCaseEffects, {type: EffectType}]
 
+/**
+ * all effect case
+ *
+ * @public
+ */
 export type DvaCaseEffectValue = DvaCaseEffects | DvaCaseEffectWithType
 
 /**
- * dva 配置中 effects 列表的类型
+ * effects in dva config
  *
  * @public
  */

src/reducers.ts

@@ -37,7 +37,7 @@ export type DvaSliceCaseReducers<
 > = DvaReducersWithEnhancer<S, Reducers> | Reducers
 
 /**
- * 没看懂，但加上去就对了
+ * valid dva reducers case
  *
  * TODO: try to understand this func
  */

src/slice.ts

@@ -40,6 +40,11 @@ export type CreateDvaSliceOption<
   subscriptions?: SubscriptionsMapObject,
 }
 
+/**
+ * dva slice result, `model` is dva model, `action` is typed action generator
+ *
+ * @public
+ */
 export type DvaSlice<
   State = any,
   CR extends DvaSliceCaseReducers<State> = DvaSliceCaseReducers<State>,