vueuse · 43081j · Jun 10, 2025 · Jan 7, 2025 · Jan 7, 2025 · Jan 10, 2025
diff --git a/packages/core/useRefHistory/index.test.ts b/packages/core/useRefHistory/index.test.ts
@@ -298,6 +298,31 @@
    expect(history.value[0].snapshot).toBe(2)
    expect(last.value.snapshot).toBe(2)
  })
+
+  it('sync: should respect shouldCommit option', () => {
+    const v = ref(0)
+    const { history } = useRefHistory(v, {
+      flush: 'sync',
+      shouldCommit: (oldValue, newValue) => newValue > 0,
+    })
+
+    expect(history.value.length).toBe(1)
+    expect(history.value[0].snapshot).toBe(0)
+
+    v.value = -1
+    expect(history.value.length).toBe(1)
+
+    v.value = 2
+    expect(history.value.length).toBe(2)
+    expect(history.value[0].snapshot).toBe(2)
+
+    v.value = -3
+    expect(history.value.length).toBe(2)
+
+    v.value = 4
+    expect(history.value.length).toBe(3)
+    expect(history.value[0].snapshot).toBe(4)
+  })
 })

 describe('useRefHistory - pre', () => {
@@ -576,4 +601,32 @@
    expect(history.value[0].snapshot).toBe(2)
    expect(last.value.snapshot).toBe(2)
  })
+
+  it('pre: should respect shouldCommit option', async () => {
+    const v = ref(0)
+    const { history } = useRefHistory(v, {
+      shouldCommit: (oldValue, newValue) => newValue > 0,
+    })
+
+    expect(history.value.length).toBe(1)
+    expect(history.value[0].snapshot).toBe(0)
+
+    v.value = -1
+    await nextTick()
+    expect(history.value.length).toBe(1)
+
+    v.value = 2
+    await nextTick()
+    expect(history.value.length).toBe(2)
+    expect(history.value[0].snapshot).toBe(2)
+
+    v.value = -3
+    await nextTick()
+    expect(history.value.length).toBe(2)
+
+    v.value = 4
+    await nextTick()
+    expect(history.value.length).toBe(3)
+    expect(history.value[0].snapshot).toBe(4)
+  })
 })
diff --git a/packages/core/useRefHistory/index.ts b/packages/core/useRefHistory/index.ts
@@ -45,6 +45,13 @@ export interface UseRefHistoryOptions<Raw, Serialized = Raw> extends Configurabl
   * Deserialize data from the history
   */
  parse?: (v: Serialized) => Raw
+  /**
+   * Function to determine if the commit should proceed
+   * @param oldValue Previous value
+   * @param newValue New value
+   * @returns boolean indicating if commit should proceed
+   */
+  shouldCommit?: (oldValue: Serialized | undefined, newValue: Raw) => boolean
 }

 export interface UseRefHistoryReturn<Raw, Serialized> extends UseManualRefHistoryReturn<Raw, Serialized> {
@@ -93,6 +100,7 @@ export function useRefHistory<Raw, Serialized = Raw>(
    deep = false,
    flush = 'pre',
    eventFilter,
+    shouldCommit,
  } = options

  const {
@@ -138,6 +146,13 @@ export function useRefHistory<Raw, Serialized = Raw>(
    // so we do not trigger an extra commit in the async watcher
    ignorePrevAsyncUpdates()

+    if (shouldCommit) {
+      const history = manualHistory.history.value
+      const lastValue = history.length > 0 ? history[history.length - 1].snapshot : undefined
+      if (!shouldCommit(lastValue, source.value))
+        return
+    }
+
    manualCommit()
  }
-Original file line number
+Diff line change
@@ -298,6 +298,31 @@
         expect(history.value[0].snapshot).toBe(2)
         expect(last.value.snapshot).toBe(2)
       })
+      it('sync: should respect shouldCommit option', () => {
+        const v = ref(0)
     Check failure
        on line 303
        in packages/core/useRefHistory/index.test.ts
  



  
      
View workflow job for this annotation

  

  
    
    GitHub Actions / lint
  

  
    
      
    
  

  
    Usage of ref() is restricted. Use shallowRef() or deepRef() instead
  




        
  
  
      
  
  
    Check failure
        on line 303
        in packages/core/useRefHistory/index.test.ts
  



  
      
View workflow job for this annotation

  

  
    
    GitHub Actions / test (22.x)
  

  
    
      
    
  

  
    Cannot find name 'ref'.
  




        
  
  
      
  
  
    Check failure
        on line 303
        in packages/core/useRefHistory/index.test.ts
  



  
      
View workflow job for this annotation

  

  
    
    GitHub Actions / test (20.x)
  

  
    
      
    
  

  
    Cannot find name 'ref'.
  




        
  
  
      
  
  
    Check failure
        on line 303
        in packages/core/useRefHistory/index.test.ts
  



  
      
View workflow job for this annotation

  

  
    
    GitHub Actions / autofix
  

  
    
      
    
  

  
    Usage of ref() is restricted. Use shallowRef() or deepRef() instead
+        const { history } = useRefHistory(v, {
+          flush: 'sync',
+          shouldCommit: (oldValue, newValue) => newValue > 0,
     Check failure
        on line 306
        in packages/core/useRefHistory/index.test.ts
  



  
      
View workflow job for this annotation

  

  
    
    GitHub Actions / test (22.x)
  

  
    
      
    
  

  
    'newValue' is of type 'unknown'.
  




        
  
  
      
  
  
    Check failure
        on line 306
        in packages/core/useRefHistory/index.test.ts
  



  
      
View workflow job for this annotation

  

  
    
    GitHub Actions / test (20.x)
  

  
    
      
    
  

  
    'newValue' is of type 'unknown'.
+        })
+        expect(history.value.length).toBe(1)
+        expect(history.value[0].snapshot).toBe(0)
+        v.value = -1
+        expect(history.value.length).toBe(1)
+        v.value = 2
+        expect(history.value.length).toBe(2)
+        expect(history.value[0].snapshot).toBe(2)
+        v.value = -3
+        expect(history.value.length).toBe(2)
+        v.value = 4
+        expect(history.value.length).toBe(3)
+        expect(history.value[0].snapshot).toBe(4)
+      })
     })
     describe('useRefHistory - pre', () => {
@@ -576,4 +601,32 @@
         expect(history.value[0].snapshot).toBe(2)
         expect(last.value.snapshot).toBe(2)
       })
+      it('pre: should respect shouldCommit option', async () => {
+        const v = ref(0)
     Check failure
        on line 606
        in packages/core/useRefHistory/index.test.ts
  



  
      
View workflow job for this annotation

  

  
    
    GitHub Actions / lint
  

  
    
      
    
  

  
    Usage of ref() is restricted. Use shallowRef() or deepRef() instead
  




        
  
  
      
  
  
    Check failure
        on line 606
        in packages/core/useRefHistory/index.test.ts
  



  
      
View workflow job for this annotation

  

  
    
    GitHub Actions / test (22.x)
  

  
    
      
    
  

  
    Cannot find name 'ref'.
  




        
  
  
      
  
  
    Check failure
        on line 606
        in packages/core/useRefHistory/index.test.ts
  



  
      
View workflow job for this annotation

  

  
    
    GitHub Actions / test (20.x)
  

  
    
      
    
  

  
    Cannot find name 'ref'.
  




        
  
  
      
  
  
    Check failure
        on line 606
        in packages/core/useRefHistory/index.test.ts
  



  
      
View workflow job for this annotation

  

  
    
    GitHub Actions / autofix
  

  
    
      
    
  

  
    Usage of ref() is restricted. Use shallowRef() or deepRef() instead
+        const { history } = useRefHistory(v, {
+          shouldCommit: (oldValue, newValue) => newValue > 0,
     Check failure
        on line 608
        in packages/core/useRefHistory/index.test.ts
  



  
      
View workflow job for this annotation

  

  
    
    GitHub Actions / test (22.x)
  

  
    
      
    
  

  
    'newValue' is of type 'unknown'.
  




        
  
  
      
  
  
    Check failure
        on line 608
        in packages/core/useRefHistory/index.test.ts
  



  
      
View workflow job for this annotation

  

  
    
    GitHub Actions / test (20.x)
  

  
    
      
    
  

  
    'newValue' is of type 'unknown'.
+        })
+        expect(history.value.length).toBe(1)
+        expect(history.value[0].snapshot).toBe(0)
+        v.value = -1
+        await nextTick()
+        expect(history.value.length).toBe(1)
+        v.value = 2
+        await nextTick()
+        expect(history.value.length).toBe(2)
+        expect(history.value[0].snapshot).toBe(2)
+        v.value = -3
+        await nextTick()
+        expect(history.value.length).toBe(2)
+        v.value = 4
+        await nextTick()
+        expect(history.value.length).toBe(3)
+        expect(history.value[0].snapshot).toBe(4)
+      })
     })