useTimeoutFn

类别

Animation

导出体积

335 B

上次更改

3 months ago

带有控制选项的 setTimeout 函数的封装

示例

源码 playground (beta)

Please wait for 3 seconds

用法

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
> | []
>
/**
 * 带有控制选项的 setTimeout 函数的封装
 *
 * @param cb 回调函数
 * @param interval 延迟的时间（毫秒）
 * @param options 可选参数
 */
export declare function useTimeoutFn
<CallbackFn
 extends AnyFn
>(
  cb
: CallbackFn
,
  interval
: MaybeRefOrGetter
<number>,
  options
?: UseTimeoutFnOptions,
): UseTimeoutFnReturn
<CallbackFn
>