跳到主要内容

useIntervalFn

分类
导出大小
367 B
上次更改
5 个月前

带控制功能的 setInterval 封装器

演示

用法

ts
import { 
useIntervalFn
} from '@vueuse/core'
const {
pause
,
resume
,
isActive
} =
useIntervalFn
(() => {
/* your function */ }, 1000)

类型声明

ts
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

来源

源代码演示文档

贡献者

Anthony Fu
Anthony Fu
Robin
Jelf
SerKo
Vida Xie
IlyaL
OrbisK
Lapor Chen
Börge Kiss
Dan Rose
sun0day
Enzo Innocenzi
wwj
Matvey Melishev
meteorlxy
Aurélio A. Heckert
xuxuhahaha
Hogne Vevle
Daiki Ojima

更新日志

v13.1.0
c1d6e - feat(shared): 确保返回类型存在 (#4659)
v12.8.0
7432f - feat(types): 废弃 MaybeRefMaybeRefOrGetter,转而使用 Vue 的原生类型 (#4636)
v12.3.0
59f75 - feat(toValue): 废弃 @vueuse/shared 中的 toValue,转而使用 Vue 的原生函数
0a9ed - feat!: 放弃对 Vue 2 的支持,优化打包并清理 (#4349)
v11.2.0
59f8c - 修复:防止在 cb 中调用 pause 后设置计时器 (#4258)

根据 MIT 许可证发布。