useTimeoutFn

分类

动画

导出大小

335 B

上次更改

4 个月前

带有控制功能的 setTimeout 封装。

演示

源代码在线演示 (beta)

请等待 3 秒

用法

import { useTimeoutFn
 } from '@vueuse/core'

const { isPending
, start
, stop
 } = useTimeoutFn
(() => {
  /* ... */
}, 3000)

类型声明

export interface UseTimeoutFnOptions {
  /**
   * Start the timer immediately
   *
   * @default true
   */
  immediate
?: boolean
  /**
   * Execute the callback immediately after calling `start`
   *
   * @default false
   */
  immediateCallback
?: boolean
}
export type UseTimeoutFnReturn
<CallbackFn
 extends AnyFn
> = Stoppable
<
  Parameters
<CallbackFn
> | []
>
/**
 * Wrapper for `setTimeout` with controls.
 *
 * @param cb
 * @param interval
 * @param options
 */
export declare function useTimeoutFn
<CallbackFn
 extends AnyFn
>(
  cb
: CallbackFn
,
  interval
: MaybeRefOrGetter
<number>,
  options
?: UseTimeoutFnOptions,
): UseTimeoutFnReturn
<CallbackFn
>