useIntervalFn

类别

Animation

导出体积

368 B

上次更改

5 days ago

带有控制功能的 setInterval 包装器

示例

源码

Hello

间隔：

使用方法

import { useIntervalFn } from '@vueuse/core'

const { pause, resume, isActive } = useIntervalFn(() => {
  /* 你的函数 */
}, 1000)

类型声明

typescript

export interface UseIntervalFnOptions {
  /**
   * 立即开始计时器
   *
   * @default true
   */
  immediate?: boolean
  /**
   * 在调用 `resume` 之后立即执行回调
   *
   * @default false
   */
  immediateCallback?: boolean
}
export type UseIntervalFnReturn = Pausable
/**
 * 带有控制功能的 `setInterval` 包装器
 *
 * @param cb
 * @param interval
 * @param options
 */
export declare function useIntervalFn(
  cb: Fn,
  interval?: MaybeRefOrGetter<number>,
  options?: UseIntervalFnOptions,
): UseIntervalFnReturn