feat: ready supports passing functions #166

Author: John60676

src/__tests__/index.test.tsx

@@ -510,6 +510,42 @@ describe('useRequest', () => {
     expect(wrapper.data).toBe('run');
   });
 
+  test('ready should work when ready is a function', async () => {
+    const count = 0;
+    const wrapper = mount(
+      defineComponent({
+        template: '<div/>',
+        setup() {
+          const count = ref(0);
+          const { loading } = useRequest(request, {
+            ready: () => count.value >= 2,
+          });
+
+          const handleUpdateCount = () => {
+            count.value += 1;
+          };
+
+          return {
+            loading,
+            handleUpdateCount,
+          };
+        },
+      }),
+    );
+    await waitForAll();
+    wrapper.handleUpdateCount();
+    expect(wrapper.loading).toBe(false);
+    await waitForAll();
+
+    wrapper.handleUpdateCount();
+    expect(wrapper.loading).toBe(true);
+    await waitForAll();
+
+    wrapper.handleUpdateCount();
+    expect(wrapper.loading).toBe(false);
+    await waitForAll();
+  });
+
   test('track ready when ready initial value is true', async () => {
     const wrapper = mount(
       defineComponent({

src/core/plugins/useReadyPlugin.ts

@@ -1,6 +1,7 @@
 import { ref, watch } from 'vue-demi';
 
 import { definePlugin } from '../definePlugin';
+import { isFunction } from '../utils';
 
 export default definePlugin(
   (queryInstance, { ready = ref(true), manual, defaultParams = [] }) => {
@@ -18,7 +19,8 @@ export default definePlugin(
     );
     return {
       onBefore() {
-        if (!ready.value) {
+        const readyFlag = isFunction(ready) ? ready() : ready.value;
+        if (!readyFlag) {
           queryInstance.loading.value = false;
           return {
             isBreak: true,

src/core/types.ts

@@ -73,7 +73,7 @@ export type BaseOptions = {
 
 export type Options<R, P extends unknown[]> = BaseOptions & {
   defaultParams?: P;
-  ready?: Ref<boolean>;
+  ready?: Ref<boolean> | (() => boolean);
   initialData?: R;
   refreshDeps?: WatchSource | WatchSource[];
   cacheKey?: string | ((params?: P) => string);