useInterval

类别

Animation

导出体积

461 B

上次更改

5 months ago

在每个间隔上增加的响应式计数器

示例

源码 playground (beta)

间隔: 0

使用方法

import { useInterval
 } from '@vueuse/core'

// 每200ms计数增加一次
const counter
 = useInterval
(200)

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

类型声明

export interface UseIntervalOptions
<Controls
 extends boolean> {
  /**
   * 暴露更多控制选项
   *
   * @default false
   */
  controls
?: Controls

  /**
   * 在调用时立即执行更新
   *
   * @default true
   */
  immediate
?: boolean
  /**
   * 每个间隔上的回调函数
   */
  callback
?: (count
: number) => void
}
export interface UseIntervalControls {
  counter
: ShallowRef
<number>
  reset
: () => void
}
export type UseIntervalReturn
 =
  | Readonly
<ShallowRef
<number>>
  | Readonly
<UseIntervalControls & Pausable
>
/**
 * 每个间隔上增加的响应式计数器
 *
 * @see https://vueuse.org/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
>