Merge pull request #13 from jedy05097952/master

chore(types): improve types

Author: runkids

src/core/types.ts

@@ -1,4 +1,4 @@
-import { Ref, UnwrapNestedRefs } from 'vue-demi'
+import { DeepReadonly, Ref, UnwrapNestedRefs } from 'vue-demi'
 
 export type ConditionsType = {
   [key: string]: any
@@ -45,29 +45,29 @@ export interface HistoryOptions<K> {
   ignore?: Array<K>
 }
 
-export interface Config<O, K> {
-  fetcher: (params: object) => Promise<any>
+export interface Config<O, Result> {
+  fetcher: (params: object) => Promise<Result>
   conditions?: O
   defaultParams?: object
   immediate?: boolean
   manual?: boolean
   initialData?: any
-  history?: HistoryOptions<K>
+  history?: HistoryOptions<keyof O>
   pollingInterval?: number | Ref<number>
   pollingWhenHidden?: boolean
   pollingWhenOffline?: boolean
   revalidateOnFocus?: boolean
   cacheProvider?: () => Cache<any>
   beforeFetch?: (conditions: O & ConditionsType, cancel: Fn) => ConditionsType
-  afterFetch?: (data: any) => any
+  afterFetch?: (data: Result) => any
   onFetchError?: (ctx: OnFetchErrorContext) => Promise<Partial<OnFetchErrorContext>> | Partial<OnFetchErrorContext>
 }
 
-export interface UseConditionWatcherReturn<O> {
+export interface UseConditionWatcherReturn<O, Result> {
   conditions: UnwrapNestedRefs<O>
   readonly isFetching: Ref<boolean>
   readonly loading: Ref<boolean>
-  readonly data: Ref<any | undefined>
+  readonly data: DeepReadonly<Ref<Result | undefined>>
   readonly error: Ref<any | undefined>
   execute: (throwOnFailed?: boolean) => void
   mutate: Mutate

src/core/useConditionWatcher.ts

@@ -20,10 +20,10 @@ import { createEvents } from './utils/createEvents'
 import { filterNoneValueObject, createParams, syncQuery2Conditions, isEquivalent, deepClone } from './utils/common'
 import { containsProp, isNoData as isDataEmpty, isObject, isServer, rAF } from './utils/helper'
 
-export default function useConditionWatcher<O extends object, K extends keyof O>(
-  config: Config<O, K>
-): UseConditionWatcherReturn<O> {
-  function isFetchConfig(obj: object): obj is Config<O, K> {
+export default function useConditionWatcher<O extends object, Result = unknown>(
+  config: Config<O, Result>
+): UseConditionWatcherReturn<O, Result> {
+  function isFetchConfig(obj: object): obj is Config<O, Result> {
     return containsProp(
       obj,
       'fetcher',
@@ -50,7 +50,7 @@ export default function useConditionWatcher<O extends object, K extends keyof O>
   }
 
   // default config
-  let watcherConfig: Config<O, K> = {
+  let watcherConfig: Config<O, Result> = {
     fetcher: config.fetcher,
     conditions: config.conditions,
     immediate: true,
@@ -76,7 +76,7 @@ export default function useConditionWatcher<O extends object, K extends keyof O>
   const isOnline = ref(true)
   const isActive = ref(true)
 
-  const data: ShallowRef = shallowRef(
+  const data: ShallowRef<Result> = shallowRef(
     cache.cached(backupIntiConditions) ? cache.get(backupIntiConditions) : watcherConfig.initialData || undefined
   )
   const error = ref(undefined)
@@ -255,15 +255,15 @@ export default function useConditionWatcher<O extends object, K extends keyof O>
   const mutate = (...args): Mutate => {
     const arg = args[0]
     if (arg === undefined) {
-      return data.value
+      return data.value as any
     }
     if (typeof arg === 'function') {
       data.value = arg(deepClone(data.value))
     } else {
       data.value = arg
     }
     cache.set({ ..._conditions }, data.value)
-    return data.value
+    return data.value as any
   }
 
   // - History mode base on vue-router