跳到主要内容

useTimeoutFn

分类
导出大小
335 B
上次更改
4 个月前

带有控制功能的 setTimeout 封装。

演示

请等待 3 秒

用法

ts
import { 
useTimeoutFn
} from '@vueuse/core'
const {
isPending
,
start
,
stop
} =
useTimeoutFn
(() => {
/* ... */ }, 3000)

类型声明

ts
export interface UseTimeoutFnOptions {
  /**
   * Start the timer immediately
   *
   * @default true
   */
  
immediate
?: boolean
/** * Execute the callback immediately after calling `start` * * @default false */
immediateCallback
?: boolean
} export type
UseTimeoutFnReturn
<
CallbackFn
extends
AnyFn
> =
Stoppable
<
Parameters
<
CallbackFn
> | []
> /** * Wrapper for `setTimeout` with controls. * * @param cb * @param interval * @param options */ export declare function
useTimeoutFn
<
CallbackFn
extends
AnyFn
>(
cb
:
CallbackFn
,
interval
:
MaybeRefOrGetter
<number>,
options
?: UseTimeoutFnOptions,
):
UseTimeoutFnReturn
<
CallbackFn
>

来源

源代码演示文档

贡献者

Anthony Fu
IlyaL
Anthony Fu
Scott Bedard
SerKo
IlyaL
Robin
OrbisK
童欧巴
Dan Rose
Kasper Seweryn
jack zhang
vaakian X
Jelf
Shinigami
Peter Shih
liaoliao666
Sergey Shumov

更新日志

v13.4.0
319d8 - feat(shared): 为 setTimeout 类型引入 TimerHandle (#4801)
v13.1.0
c1d6e - feat(shared): 确保返回类型存在 (#4659)
v12.8.0
7432f - feat(types): 废弃 MaybeRefMaybeRefOrGetter,转而使用 Vue 的原生类型 (#4636)
v12.6.0
64c53 - feat(useTimtoutFn,useTimeoutPoll): 行为对齐 (#4543)
v12.3.0
59f75 - feat(toValue): 废弃 @vueuse/shared 中的 toValue,转而使用 Vue 的原生函数
0a9ed - feat!: 放弃对 Vue 2 的支持,优化打包并清理 (#4349)

根据 MIT 许可证发布。