chore: improve types

Author: runkids

src/core/types.ts

@@ -1,9 +1,5 @@
 import { Ref, UnwrapNestedRefs } from 'vue-demi'
 
-export type ConditionsType = {
-  [key: string]: any
-}
-
 type ArgumentsTuple = [any, ...unknown[]] | readonly [any, ...unknown[]]
 export type Arguments = string | ArgumentsTuple | Record<any, any> | null | undefined | false
 export type Key = Arguments | (() => Arguments)
@@ -13,13 +9,13 @@ export interface Cache<Data = any> {
   delete(key: Key): void
 }
 
-export type Fn = () => void
+export type VoidFn = () => void
 
 export type Conditions<T> = {
   [K in keyof T]: T[K]
 }
 
-export type OnConditionsChangeReturnValue<C> = Partial<UnwrapNestedRefs<C>> & ConditionsType
+export type OnConditionsChangeReturnValue<C> = Partial<UnwrapNestedRefs<C>>
 
 export type OnConditionsChangeContext<O> = (
   newConditions: OnConditionsChangeReturnValue<O>,
@@ -45,10 +41,10 @@ export interface HistoryOptions<K> {
   ignore?: Array<K>
 }
 
-export interface Config<Result = unknown, Cond = object, AfterResult extends unknown = Result> {
+export interface Config<Cond = Record<string, any>, Result = unknown, AfterFetchResult extends unknown = Result> {
   fetcher: (...args: any) => Promise<Result>
   conditions?: Cond
-  defaultParams?: object
+  defaultParams?: Record<string, any>
   immediate?: boolean
   manual?: boolean
   initialData?: any
@@ -58,12 +54,16 @@ export interface Config<Result = unknown, Cond = object, AfterResult extends unk
   pollingWhenOffline?: boolean
   revalidateOnFocus?: boolean
   cacheProvider?: () => Cache<any>
-  beforeFetch?: (conditions: Cond, cancel: Fn) => Partial<Cond>
-  afterFetch?: (data: Result) => AfterResult extends Result ? Result : AfterResult
+  beforeFetch?: (conditions: Cond, cancel: VoidFn) => Promise<Partial<Cond>> | Partial<Cond>
+  afterFetch?: (
+    data: Result
+  ) => Promise<AfterFetchResult extends Result ? Result : AfterFetchResult> | AfterFetchResult extends Result
+    ? Result
+    : AfterFetchResult
   onFetchError?: (ctx: OnFetchErrorContext) => Promise<Partial<OnFetchErrorContext>> | Partial<OnFetchErrorContext>
 }
 
-export interface UseConditionWatcherReturn<Result, Cond> {
+export interface UseConditionWatcherReturn<Cond, Result> {
   conditions: UnwrapNestedRefs<Cond>
   readonly isFetching: Ref<boolean>
   readonly loading: Ref<boolean>

src/core/useConditionWatcher.ts

@@ -21,13 +21,13 @@ import { filterNoneValueObject, createParams, syncQuery2Conditions, isEquivalent
 import { containsProp, isNoData as isDataEmpty, isObject, isServer, rAF } from './utils/helper'
 
 export default function useConditionWatcher<
-  Result extends unknown,
   Cond extends Record<string, any>,
-  AfterResult extends unknown = Result
+  Result extends unknown,
+  AfterFetchResult extends unknown = Result
 >(
-  config: Config<Result, Cond, AfterResult>
-): UseConditionWatcherReturn<AfterResult extends Result ? Result : AfterResult, Cond> {
-  function isFetchConfig(obj: object): obj is typeof config {
+  config: Config<Cond, Result, AfterFetchResult>
+): UseConditionWatcherReturn<Cond, AfterFetchResult extends Result ? Result : AfterFetchResult> {
+  function isFetchConfig(obj: Record<string, any>): obj is typeof config {
     return containsProp(
       obj,
       'fetcher',
@@ -103,7 +103,7 @@ export default function useConditionWatcher<
     stopVisibilityEvent,
   } = createEvents()
 
-  const resetConditions = (cond?: object): void => {
+  const resetConditions = (cond?: Record<string, any>): void => {
     Object.assign(_conditions, isObject(cond) && !cond.type ? cond : backupIntiConditions)
   }
 
@@ -115,7 +115,7 @@ export default function useConditionWatcher<
     isFetching.value = true
     error.value = undefined
     const conditions2Object: Conditions<Cond> = conditions
-    let customConditions: object = {}
+    let customConditions: Record<string, any> = {}
     const deepCopyCondition: Conditions<Cond> = deepClone(conditions2Object)
 
     if (typeof watcherConfig.beforeFetch === 'function') {
@@ -144,7 +144,7 @@ export default function useConditionWatcher<
      * return result will be {age: 0}
      */
     query.value = filterNoneValueObject(validateCustomConditions ? customConditions : conditions2Object)
-    const finalConditions: object = createParams(query.value, watcherConfig.defaultParams)
+    const finalConditions: Record<string, any> = createParams(query.value, watcherConfig.defaultParams)
 
     let responseData: any = undefined
 
@@ -276,7 +276,7 @@ export default function useConditionWatcher<
       sync: config.history.sync,
       ignore: config.history.ignore || [],
       navigation: config.history.navigation || 'push',
-      listener(parsedQuery: object) {
+      listener(parsedQuery: Record<string, any>) {
         const queryObject = Object.keys(parsedQuery).length ? parsedQuery : backupIntiConditions
         syncQuery2Conditions(_conditions, queryObject, backupIntiConditions)
       },

src/core/utils/common.ts

@@ -1,4 +1,4 @@
-import { ConditionsType } from '../types'
+type ConditionsType = Record<string, any>
 
 declare global {
   interface ObjectConstructor {

src/index.ts

@@ -1,7 +1,7 @@
 export { default as useConditionWatcher } from './core/useConditionWatcher'
 
 export type {
-  Fn,
+  VoidFn,
   Conditions,
   OnFetchErrorContext,
   Config,