feat(useAxios): added onFinish callback (#2829)

vueuse · Mar 28, 2023 · a2f334d · a2f334d
1 parent e4ac088
commit a2f334d
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/packages/integrations/useAxios/index.test.ts b/packages/integrations/useAxios/index.test.ts
@@ -300,4 +300,15 @@ describe('useAxios', () => {
     expect(isFinished.value).toBeTruthy()
     expect(isLoading.value).toBeFalsy()
   })
+
+  test('should call onFinish', async () => {
+    const onFinish = vitest.fn()
+    const { execute, isLoading, isFinished } = useAxios(url, config, { ...options, onFinish })
+    expect(isLoading.value).toBeFalsy()
+
+    await execute()
+    expect(onFinish).toHaveBeenCalled()
+    expect(isFinished.value).toBeTruthy()
+    expect(isLoading.value).toBeFalsy()
+  })
 })
diff --git a/packages/integrations/useAxios/index.ts b/packages/integrations/useAxios/index.ts
@@ -109,6 +109,10 @@ export interface UseAxiosOptions<T = any> {
    * Callback when success is caught.
    */
   onSuccess?: (data: T) => void
+  /**
+   * Callback when request is finished.
+   */
+  onFinish?: () => void
 }
 type OverallUseAxiosReturn<T, R, D> = StrictUseAxiosReturn<T, R, D> | EasyUseAxiosReturn<T, R, D>
 
@@ -215,7 +219,10 @@ export function useAxios<T = any, R = AxiosResponse<T>, D = any>(...args: any[])
         error.value = e
         options.onError?.(e)
       })
-      .finally(() => loading(false))
+      .finally(() => {
+        options.onFinish?.()
+        loading(false)
+      })
     return { then }
   }
   if (options.immediate && url)