feat(router): transform get / set (#4326)

Co-authored-by: Anthony Fu <[email protected]> Co-authored-by: Anthony Fu <[email protected]>
vueuse · Nov 21, 2024 · 65aa076 · 65aa076
1 parent 1d5e978
commit 65aa076
Show file tree

Hide file tree

Showing 5 changed files with 70 additions and 7 deletions.
diff --git a/packages/router/_types.ts b/packages/router/_types.ts
@@ -28,5 +28,8 @@ export interface ReactiveRouteOptionsWithTransform<V, R> extends ReactiveRouteOp
   /**
    * Function to transform data before return
    */
-  transform?: (val: V) => R
+  transform?: ((val: V) => R) | {
+    get: (value: V) => R
+    set: (value: R) => V
+  }
 }
diff --git a/packages/router/useRouteParams/index.test.ts b/packages/router/useRouteParams/index.test.ts
@@ -40,6 +40,31 @@ describe('useRouteParams', () => {
     expect(id.value).toBe(1)
   })
 
+  it('should handle transform get/set', async () => {
+    let route = getRoute({
+      serialized: '{"foo":"bar"}',
+    })
+    const router = { replace: (r: any) => route = r } as any
+
+    const object = useRouteParams('serialized', undefined, {
+      transform: {
+        get: (value: string) => JSON.parse(value),
+        set: (value: any) => JSON.stringify(value),
+      },
+      router,
+      route,
+    })
+
+    expect(object.value).toEqual({ foo: 'bar' })
+
+    object.value = { foo: 'baz' }
+
+    await nextTick()
+
+    expect(route.params.serialized).toBe('{"foo":"baz"}')
+    expect(object.value).toEqual({ foo: 'baz' })
+  })
+
   it('should re-evaluate the value immediately', () => {
     let route = getRoute()
     const router = { replace: (r: any) => route = r } as any

diff --git a/packages/router/useRouteParams/index.ts b/packages/router/useRouteParams/index.ts
@@ -33,9 +33,12 @@ export function useRouteParams<
     mode = 'replace',
     route = useRoute(),
     router = useRouter(),
-    transform = value => value as any as K,
+    transform,
   } = options
 
+  const transformGet = transform && 'get' in transform ? transform.get : transform ?? ((value: T) => value as any as K)
+  const transformSet = transform && 'set' in transform ? transform.set : (value: K) => value as any as T
+
   if (!_queue.has(router))
     _queue.set(router, new Map())
 
@@ -56,9 +59,11 @@ export function useRouteParams<
       get() {
         track()
 
-        return transform(param !== undefined && param !== '' ? param : toValue(defaultValue))
+        return transformGet(param !== undefined && param !== '' ? param : toValue(defaultValue))
       },
       set(v) {
+        v = transformSet(v)
+
         if (param === v)
           return
 
@@ -92,7 +97,7 @@ export function useRouteParams<
   watch(
     () => route.params[name],
     (v) => {
-      if (param === transform(v as T))
+      if (param === transformGet(v as T))
         return
 
       param = v

diff --git a/packages/router/useRouteQuery/index.test.ts b/packages/router/useRouteQuery/index.test.ts
@@ -38,6 +38,31 @@ describe('useRouteQuery', () => {
     expect(tags.value).toEqual(['vite'])
   })
 
+  it('should handle transform get/set', async () => {
+    let route = getRoute({
+      serialized: '{"foo":"bar"}',
+    })
+    const router = { replace: (r: any) => route = r } as any
+
+    const object = useRouteQuery('serialized', undefined, {
+      transform: {
+        get: (value: string) => JSON.parse(value),
+        set: (value: any) => JSON.stringify(value),
+      },
+      router,
+      route,
+    })
+
+    expect(object.value).toEqual({ foo: 'bar' })
+
+    object.value = { foo: 'baz' }
+
+    await nextTick()
+
+    expect(route.query.serialized).toBe('{"foo":"baz"}')
+    expect(object.value).toEqual({ foo: 'baz' })
+  })
+
   it('should re-evaluate the value immediately', () => {
     let route = getRoute({
       search: 'vue3',

diff --git a/packages/router/useRouteQuery/index.ts b/packages/router/useRouteQuery/index.ts
@@ -33,9 +33,12 @@ export function useRouteQuery<
     mode = 'replace',
     route = useRoute(),
     router = useRouter(),
-    transform = value => value as any as K,
+    transform,
   } = options
 
+  const transformGet = transform && 'get' in transform ? transform.get : transform ?? ((value: T) => value as any as K)
+  const transformSet = transform && 'set' in transform ? transform.set : (value: K) => value as any as T
+
   if (!_queue.has(router))
     _queue.set(router, new Map())
 
@@ -56,9 +59,11 @@ export function useRouteQuery<
       get() {
         track()
 
-        return transform(query !== undefined ? query : toValue(defaultValue))
+        return transformGet(query !== undefined ? query : toValue(defaultValue))
       },
       set(v) {
+        v = transformSet(v)
+
         if (query === v)
           return
 
@@ -89,7 +94,7 @@ export function useRouteQuery<
   watch(
     () => route.query[name],
     (v) => {
-      if (query === transform(v as T))
+      if (query === transformGet(v as T))
         return
 
       query = v