useIntervalFn

分类

动画

导出大小

367 B

上次更改

5 个月前

带控制功能的 setInterval 封装器

演示

源代码演练场 (测试版)

你好

间隔

用法

import { useIntervalFn
 } from '@vueuse/core'

const { pause
, resume
, isActive
 } = useIntervalFn
(() => {
  /* your function */
}, 1000)

类型声明

export interface UseIntervalFnOptions {
  /**
   * Start the timer immediately
   *
   * @default true
   */
  immediate
?: boolean
  /**
   * Execute the callback immediately after calling `resume`
   *
   * @default false
   */
  immediateCallback
?: boolean
}
export type UseIntervalFnReturn
 = Pausable

/**
 * Wrapper for `setInterval` with controls
 *
 * @see https://vueuse.org.cn/useIntervalFn
 * @param cb
 * @param interval
 * @param options
 */
export declare function useIntervalFn
(
  cb
: Fn
,
  interval
?: MaybeRefOrGetter
<number>,
  options
?: UseIntervalFnOptions,
): UseIntervalFnReturn