fix(useAxios): rename aborted to isAborted (#1519)

vueuse · Apr 23, 2022 · e2a9ac3 · e2a9ac3
1 parent af3e877
commit e2a9ac3
Showing 1 changed file with 13 additions and 7 deletions.
diff --git a/packages/integrations/useAxios/index.ts b/packages/integrations/useAxios/index.ts
@@ -25,11 +25,11 @@ export interface UseAxiosReturn<T> {
    * Indicates if the request is currently loading
    */
   isLoading: Ref<boolean>
-
+  
   /**
    * Indicates if the request was canceled
    */
-  aborted: Ref<boolean>
+  isAborted: Ref<boolean>
 
   /**
    * Any errors that may have occurred
@@ -47,9 +47,14 @@ export interface UseAxiosReturn<T> {
   finished: Ref<boolean>
 
   /**
-   * loading alias
+   * isLoading alias
    */
   loading: Ref<boolean>
+
+  /**
+   * isAborted alias
+   */
+  aborted: Ref<boolean>
 
   /**
    * abort alias
@@ -126,7 +131,7 @@ export function useAxios<T = any>(...args: any[]): OverallUseAxiosReturn<T> & Pr
   const data = shallowRef<T>()
   const isFinished = ref(false)
   const isLoading = ref(false)
-  const aborted = ref(false)
+  const isAborted = ref(false)
   const error = shallowRef<AxiosError<T>>()
 
   const cancelToken: CancelTokenSource = axios.CancelToken.source()
@@ -135,7 +140,7 @@ export function useAxios<T = any>(...args: any[]): OverallUseAxiosReturn<T> & Pr
       return
 
     cancelToken.cancel(message)
-    aborted.value = true
+    isAborted.value = true
     isLoading.value = false
     isFinished.value = false
   }
@@ -178,8 +183,9 @@ export function useAxios<T = any>(...args: any[]): OverallUseAxiosReturn<T> & Pr
     isFinished,
     isLoading,
     cancel: abort,
-    canceled: aborted,
-    aborted,
+    isAborted,
+    canceled: isAborted,
+    aborted: isAborted,
     abort,
     execute,
   } as OverallUseAxiosReturn<T>