fix: 🧩 parameter processing

vueuse · 17359898647 · Jan 9, 2024 · Jan 9, 2024 · Jan 10, 2024 · Jan 10, 2024
commit e40f51b7760abd75c1a4473696189f31bc76ad6c
diff --git a/packages/shared/refThrottled/index.test.ts b/packages/shared/refThrottled/index.test.ts
@@ -6,7 +6,6 @@ describe('refThrottled', () => {
   it('should handle string type', async () => {
     const strRef = ref('Hello')
     const throttledRef = refThrottled(strRef, 100)
-
     expect(throttledRef.value).toBe('Hello')
 
     strRef.value = 'World'
@@ -71,4 +70,22 @@ describe('refThrottled', () => {
     expect(throttledRef?.value).toEqual(objRef.value)
     expect(error).toBeNull()
   })
+
+  it('should handle object options', async () => {
+    const strRef = ref('Hello')
+    const throttledRef = refThrottled(strRef, 100)
+    const objParamsThrottledRef = refThrottled({
+      value: strRef,
+      delay: 100,
+    })
+    expect(throttledRef.value).toBe('Hello')
+    expect(objParamsThrottledRef.value).toBe('Hello')
+    strRef.value = 'World'
+    expect(throttledRef.value).toBe('Hello')
+    expect(objParamsThrottledRef.value).toBe('Hello')
+    await new Promise(resolve => setTimeout(resolve, 200))
+
+    expect(throttledRef.value).toBe('World')
+    expect(objParamsThrottledRef.value).toBe('World')
+  })
 })
diff --git a/packages/shared/refThrottled/index.ts b/packages/shared/refThrottled/index.ts
@@ -6,11 +6,11 @@ import { useThrottleFn } from '../useThrottleFn'
 function isReferenceType(value: any) {
   return value !== null && (typeof value === 'object' || typeof value === 'function')
 }
-interface RefThrottledOptions<T> extends Pick<WatchOptions, 'immediate' | 'deep'> {
+interface RefThrottledOptions<T> extends WatchOptions {
   /**
    * Ref value to be watched with throttle effect.
    */
-  origin: Ref<T>
+  value: Ref<T>
   /**
    * A zero-or-greater delay in milliseconds. For event callbacks, values around 100 or 250 (or even higher) are most useful.
    *
@@ -51,8 +51,27 @@ export function refThrottled<T>(value: Ref<T>, delay?: number, trailing?: boolea
 export function refThrottled<T>(options: RefThrottledOptions<T>): Ref<T>
 export function refThrottled<T>(...args: any[]): Ref<T> {
   const isFirstRef = isRef(args[0])
-  const value = isFirstRef ? args[0] : args[0].origin
-  const [delay = 200, trailing = true, leading = true, deep = true, immediate = true, cloneHandler = cloneFnJSON] = isFirstRef ? args.slice(1) : args[0]
+  const value = isFirstRef ? args[0] : args[0].value
+  // const [delay = 200, trailing = true, leading = true, deep = true, immediate = true, cloneHandler = cloneFnJSON] = isFirstRef ? args.slice(1) : args[0]
+  let delay: number
+  let trailing: boolean
+  let leading: boolean
+  let deep: boolean
+  let immediate: boolean
+  let cloneHandler: (value: T) => T
+  if (isFirstRef) {
+    [delay = 200, trailing = true, leading = true, deep = true, immediate = true, cloneHandler = cloneFnJSON] = args.slice(1)
+  }
+  else {
+    const { delay: pDelay = 200, trailing: pTrailing = true, leading: pLeading = true, deep: pDeep = true, immediate: pImmediate = true, cloneHandler: pCloneHandler = cloneFnJSON } = args[0]
+    delay = pDelay
+    trailing = pTrailing
+    leading = pLeading
+    deep = pDeep
+    immediate = pImmediate
+    cloneHandler = pCloneHandler
+  }
+
   if (delay <= 0)
     return value
   const isEqualityClone = cloneHandler === cloneFnJSON
@@ -74,6 +93,7 @@ export function refThrottled<T>(...args: any[]): Ref<T> {
           }
         }
       },
+      ...(isFirstRef ? {} : args[0]),
       deep,
       immediate,
     },