feat: add a way to wait for query update

fixes: #48
Djaler · Dec 4, 2022 · fda600a · fda600a
1 parent 10f1b67
commit fda600a
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -1,2 +1,3 @@
 export * from './transformers';
 export { useRouteQuery } from './useRouteQuery';
+export { waitForQueryUpdate } from './queue-query-update';
diff --git a/packages/core/src/queue-query-update.ts b/packages/core/src/queue-query-update.ts
@@ -28,6 +28,12 @@ export function queueQueryUpdate(
     void queryReplaceQueue.run(currentQuery);
 }
 
+export async function waitForQueryUpdate() {
+    if (queryReplaceQueue) {
+        await queryReplaceQueue.waitForFinish();
+    }
+}
+
 async function updateQuery(router: Router, previousQuery: RouteQuery, query: RouteQuery) {
     try {
         await router.replace({

diff --git a/packages/tests-base/index.ts b/packages/tests-base/index.ts
@@ -1,6 +1,6 @@
 import { setImmediate } from 'timers';
 import { expect, TestAPI } from 'vitest';
-import { RouteQueryTransformer, useRouteQuery } from 'vue-use-route-query/src';
+import { RouteQueryTransformer, useRouteQuery, waitForQueryUpdate } from 'vue-use-route-query/src';
 import { RouteQuery } from 'vue-use-route-query/src/types';
 
 interface MountResult<R> {
@@ -186,6 +186,15 @@ export function testUseRouteQuery(
 
         expect(getCurrentQuery().array).toBe('foo,bar');
     });
+
+    it('should allow to wait for query update', async () => {
+        const { result } = mountComposition(() => useRouteQuery('foo', null));
+
+        result.value = 'bar';
+        await waitForQueryUpdate();
+
+        expect(getCurrentQuery().foo).toBe('bar');
+    });
 }
 
 function flushPromises(): Promise<void> {