fix(useTimeoutPoll): immediate default value should be true (#4232)

Co-authored-by: Anthony Fu <[email protected]>
vueuse · Jan 2, 2025 · 0450d82 · 0450d82
1 parent 302be9a
commit 0450d82
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/packages/core/useTimeoutPoll/index.ts b/packages/core/useTimeoutPoll/index.ts
@@ -2,7 +2,15 @@ import type { Awaitable, MaybeRefOrGetter, Pausable, UseTimeoutFnOptions } from
 import { tryOnScopeDispose, useTimeoutFn } from '@vueuse/shared'
 import { ref } from 'vue'
 
-export function useTimeoutPoll(fn: () => Awaitable<void>, interval: MaybeRefOrGetter<number>, timeoutPollOptions?: UseTimeoutFnOptions): Pausable {
+export function useTimeoutPoll(
+  fn: () => Awaitable<void>,
+  interval: MaybeRefOrGetter<number>,
+  options: UseTimeoutFnOptions = {},
+): Pausable {
+  const {
+    immediate = true,
+  } = options
+
   const { start } = useTimeoutFn(loop, interval, { immediate: false })
 
   const isActive = ref(false)
@@ -26,7 +34,7 @@ export function useTimeoutPoll(fn: () => Awaitable<void>, interval: MaybeRefOrGe
     isActive.value = false
   }
 
-  if (timeoutPollOptions?.immediate)
+  if (immediate)
     resume()
 
   tryOnScopeDispose(pause)