feat(UseRefHistoryOptions): add beforeCommit

vueuse · 43081j · Jun 10, 2025 · Jan 7, 2025 · Jan 7, 2025 · Jan 10, 2025
commit 44d7d0222e83bb8c8ef99e9f33d31a1974c2c07f
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
+   */
+  beforeCommit?: (oldValue: Raw, 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,
+    beforeCommit,
   } = 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 (beforeCommit) {
+      const history = manualHistory.history.value
+      const lastValue = history.length > 0 ? history[history.length - 1] : undefined
+      if (!beforeCommit(lastValue, source.value))
+        return
+    }
+
     manualCommit()
   }