feat(syncRef): enhance type (#3678)

vueuse · Dec 27, 2023 · dad663e · dad663e
1 parent 0c246cc
commit dad663e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/packages/shared/syncRef/index.test.ts b/packages/shared/syncRef/index.test.ts
@@ -102,6 +102,7 @@ describe('syncRef', () => {
     const ref0 = ref(0)
     const ref1 = ref(1)
     const refString = ref('1')
+    const refNumber = ref(1)
     const refNumString = ref<number | string>(1)
     const refNumBoolean = ref<number | boolean>(1)
     // L = A && direction === 'both'
@@ -253,5 +254,12 @@ describe('syncRef', () => {
     const bool0 = ref(false)
     const bool1 = ref(false)
     syncRef(bool0, bool1)
+
+    syncRef(refNumber, refString, {
+      // @ts-expect-error lack rtl func
+      transform: {
+        ltr: v => String(v),
+      },
+    })
   })
 })
diff --git a/packages/shared/syncRef/index.ts b/packages/shared/syncRef/index.ts
@@ -130,7 +130,7 @@ export type SyncRefOptions<L, R, D extends Direction> = ConfigurableFlushSync &
  * 3. L ⊆ R
  * 4. L ∩ R = ∅
  */
-export function syncRef<L, R, D extends Direction>(
+export function syncRef<L, R, D extends Direction = 'both'>(
   left: Ref<L>,
   right: Ref<R>,
   ...[options]: Equal<L, R> extends true