feat(useInterval): add reset function (#2686)

Co-authored-by: Mohammad Agbareya <muhammed@irestweb.com>
vueuse · Feb 18, 2023 · 81db660 · 81db660
1 parent 111892e
commit 81db660
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/packages/shared/useInterval/index.md b/packages/shared/useInterval/index.md
@@ -16,5 +16,5 @@ const counter = useInterval(200)
 ```
 
 ```ts
-const { counter, pause, resume } = useInterval(200, { controls: true })
+const { counter, reset, pause, resume } = useInterval(200, { controls: true })
 ```
diff --git a/packages/shared/useInterval/index.ts b/packages/shared/useInterval/index.ts
@@ -41,6 +41,7 @@ export function useInterval(interval: MaybeComputedRef<number> = 1000, options:
 
   const counter = ref(0)
   const update = () => counter.value += 1
+  const reset = () => counter.value = 0
   const controls = useIntervalFn(callback
     ? () => {
         update()
@@ -51,6 +52,7 @@ export function useInterval(interval: MaybeComputedRef<number> = 1000, options:
   if (exposeControls) {
     return {
       counter,
+      reset,
       ...controls,
     }
   }