fix(useInterval): fix types

vueuse · Feb 18, 2023 · db66c02 · db66c02
1 parent b0ac4fa
commit db66c02
Showing 1 changed file with 20 additions and 8 deletions.
diff --git a/packages/shared/useInterval/index.ts b/packages/shared/useInterval/index.ts
@@ -17,12 +17,18 @@ export interface UseIntervalOptions<Controls extends boolean> {
    * @default true
    */
   immediate?: boolean
+
   /**
    * Callback on every interval
    */
   callback?: (count: number) => void
 }
 
+export interface UseIntervalControls {
+  counter: Ref<number>
+  reset: () => void
+}
+
 /**
  * Reactive counter increases on every interval
  *
@@ -31,7 +37,7 @@ export interface UseIntervalOptions<Controls extends boolean> {
  * @param options
  */
 export function useInterval(interval?: MaybeComputedRef<number>, options?: UseIntervalOptions<false>): Ref<number>
-export function useInterval(interval: MaybeComputedRef<number>, options: UseIntervalOptions<true>): { counter: Ref<number> } & Pausable
+export function useInterval(interval: MaybeComputedRef<number>, options: UseIntervalOptions<true>): UseIntervalControls & Pausable
 export function useInterval(interval: MaybeComputedRef<number> = 1000, options: UseIntervalOptions<boolean> = {}) {
   const {
     controls: exposeControls = false,
@@ -41,13 +47,19 @@ 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()
-        callback(counter.value)
-      }
-    : update, interval, { immediate })
+  const reset = () => {
+    counter.value = 0
+  }
+  const controls = useIntervalFn(
+    callback
+      ? () => {
+          update()
+          callback(counter.value)
+        }
+      : update,
+    interval,
+    { immediate },
+  )
 
   if (exposeControls) {
     return {