fix(useTimeoutFn,useTimeout)!: rename type TimeoutOptions to `UseTi…

…meoutOptions` and `TimeoutFnOptions` to `UseTimeoutFnOptions` (#1944)
vueuse · Jul 17, 2022 · 4ca7070 · 4ca7070
1 parent 43732c2
commit 4ca7070
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/packages/core/useTimeoutPoll/index.ts b/packages/core/useTimeoutPoll/index.ts
@@ -1,8 +1,8 @@
 import { ref } from 'vue-demi'
-import type { Awaitable, MaybeComputedRef, Pausable, TimeoutFnOptions } from '@vueuse/shared'
+import type { Awaitable, MaybeComputedRef, Pausable, UseTimeoutFnOptions } from '@vueuse/shared'
 import { tryOnScopeDispose, useTimeoutFn } from '@vueuse/shared'
 
-export function useTimeoutPoll(fn: () => Awaitable<void>, interval: MaybeComputedRef<number>, timeoutPollOptions?: TimeoutFnOptions): Pausable {
+export function useTimeoutPoll(fn: () => Awaitable<void>, interval: MaybeComputedRef<number>, timeoutPollOptions?: UseTimeoutFnOptions): Pausable {
   const { start } = useTimeoutFn(loop, interval)
 
   const isActive = ref(false)

diff --git a/packages/shared/useTimeout/index.ts b/packages/shared/useTimeout/index.ts
@@ -1,11 +1,11 @@
 import type { ComputedRef } from 'vue-demi'
 import { computed } from 'vue-demi'
-import type { TimeoutFnOptions } from '../useTimeoutFn'
+import type { UseTimeoutFnOptions } from '../useTimeoutFn'
 import { useTimeoutFn } from '../useTimeoutFn'
 import type { Stoppable } from '../utils'
 import { noop } from '../utils'
 
-export interface TimeoutOptions<Controls extends boolean> extends TimeoutFnOptions {
+export interface UseTimeoutOptions<Controls extends boolean> extends UseTimeoutFnOptions {
   /**
    * Expose more controls
    *
@@ -21,9 +21,9 @@ export interface TimeoutOptions<Controls extends boolean> extends TimeoutFnOptio
  * @param interval
  * @param immediate
  */
-export function useTimeout(interval?: number, options?: TimeoutOptions<false>): ComputedRef<boolean>
-export function useTimeout(interval: number, options: TimeoutOptions<true>): { ready: ComputedRef<boolean> } & Stoppable
-export function useTimeout(interval = 1000, options: TimeoutOptions<boolean> = {}) {
+export function useTimeout(interval?: number, options?: UseTimeoutOptions<false>): ComputedRef<boolean>
+export function useTimeout(interval: number, options: UseTimeoutOptions<true>): { ready: ComputedRef<boolean> } & Stoppable
+export function useTimeout(interval = 1000, options: UseTimeoutOptions<boolean> = {}) {
   const {
     controls: exposeControls = false,
   } = options

diff --git a/packages/shared/useTimeoutFn/index.ts b/packages/shared/useTimeoutFn/index.ts
@@ -5,7 +5,7 @@ import { tryOnScopeDispose } from '../tryOnScopeDispose'
 import type { Stoppable } from '../utils'
 import { isClient } from '../utils'
 
-export interface TimeoutFnOptions {
+export interface UseTimeoutFnOptions {
   /**
    * Start the timer immediate after calling this function
    *
@@ -24,7 +24,7 @@ export interface TimeoutFnOptions {
 export function useTimeoutFn(
   cb: (...args: unknown[]) => any,
   interval: MaybeComputedRef<number>,
-  options: TimeoutFnOptions = {},
+  options: UseTimeoutFnOptions = {},
 ): Stoppable {
   const {
     immediate = true,