From abf87fe9be4429036b57f99122b4227792cac701 Mon Sep 17 00:00:00 2001 From: okxiaoliang4 <353742991@qq.com> Date: Mon, 18 Jul 2022 01:12:19 +0800 Subject: [PATCH] fix(useTimeoutFn,useTimeout)!: rename type `TimeoutOptions` to `UseTimeoutOptions` and `TimeoutFnOptions` to `UseTimeoutFnOptions` --- packages/core/useTimeoutPoll/index.ts | 4 ++-- packages/shared/useTimeout/index.ts | 10 +++++----- packages/shared/useTimeoutFn/index.ts | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/packages/core/useTimeoutPoll/index.ts b/packages/core/useTimeoutPoll/index.ts index 3c342b0603e..3a91dc06036 100644 --- 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, interval: MaybeComputedRef, timeoutPollOptions?: TimeoutFnOptions): Pausable { +export function useTimeoutPoll(fn: () => Awaitable, interval: MaybeComputedRef, 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 index 1e709ee8f2d..73e4bc738f8 100644 --- 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 extends TimeoutFnOptions { +export interface UseTimeoutOptions extends UseTimeoutFnOptions { /** * Expose more controls * @@ -21,9 +21,9 @@ export interface TimeoutOptions extends TimeoutFnOptio * @param interval * @param immediate */ -export function useTimeout(interval?: number, options?: TimeoutOptions): ComputedRef -export function useTimeout(interval: number, options: TimeoutOptions): { ready: ComputedRef } & Stoppable -export function useTimeout(interval = 1000, options: TimeoutOptions = {}) { +export function useTimeout(interval?: number, options?: UseTimeoutOptions): ComputedRef +export function useTimeout(interval: number, options: UseTimeoutOptions): { ready: ComputedRef } & Stoppable +export function useTimeout(interval = 1000, options: UseTimeoutOptions = {}) { const { controls: exposeControls = false, } = options diff --git a/packages/shared/useTimeoutFn/index.ts b/packages/shared/useTimeoutFn/index.ts index fa91ce83588..7db4bd93304 100644 --- 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, - options: TimeoutFnOptions = {}, + options: UseTimeoutFnOptions = {}, ): Stoppable { const { immediate = true,