useInterval

分类

动画

导出大小

461 B

上次更改

7 个月前

响应式计数器，在每个时间间隔内增加

演示

源代码演练场（测试版）

间隔触发次数：0

用法

import { useInterval
 } from '@vueuse/core'

// count will increase every 200ms
const counter
 = useInterval
(200)

const { counter
, reset
, pause
, resume
 } = useInterval
(200, {
  controls
: true
})

类型声明

export interface UseIntervalOptions
<Controls
 extends boolean> {
  /**
   * Expose more controls
   *
   * @default false
   */
  controls
?: Controls

  /**
   * Execute the update immediately on calling
   *
   * @default true
   */
  immediate
?: boolean
  /**
   * Callback on every interval
   */
  callback
?: (count
: number) => void
}
export interface UseIntervalControls {
  counter
: ShallowRef
<number>
  reset
: () => void
}
export type UseIntervalReturn
 =
  | Readonly
<ShallowRef
<number>>
  | Readonly
<UseIntervalControls & Pausable
>
/**
 * Reactive counter increases on every interval
 *
 * @see https://vueuse.org.cn/useInterval
 * @param interval
 * @param options
 */
export declare function useInterval
(
  interval
?: MaybeRefOrGetter
<number>,
  options
?: UseIntervalOptions
<false>,
): Readonly
<ShallowRef
<number>>
export declare function useInterval
(
  interval
: MaybeRefOrGetter
<number>,
  options
: UseIntervalOptions
<true>,
): Readonly
<UseIntervalControls & Pausable
>