refactor: rename beforeCommit to shouldCommit

vueuse · JonathanSchndr · Jan 7, 2025 · Jan 7, 2025 · Jan 10, 2025 · Feb 3, 2025
commit ca3bff7b0613b9ce40855f3fbd40e5a24ae5da52
diff --git a/packages/core/useRefHistory/index.ts b/packages/core/useRefHistory/index.ts
@@ -51,7 +51,7 @@ export interface UseRefHistoryOptions<Raw, Serialized = Raw> extends Configurabl
   * @param newValue New value
   * @returns boolean indicating if commit should proceed
   */
-  beforeCommit?: (oldValue: Serialized | undefined, newValue: Raw) => boolean
+  shouldCommit?: (oldValue: Serialized | undefined, newValue: Raw) => boolean
 }

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

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

-    if (beforeCommit) {
+    if (shouldCommit) {
      const history = manualHistory.history.value
      const lastValue = history.length > 0 ? history[history.length - 1].snapshot : undefined
-      if (!beforeCommit(lastValue, source.value))
+      if (!shouldCommit(lastValue, source.value))
        return
    }