跳到主要内容

useTimeout

分类
导出大小
402 B
上次更改
7 个月前

在给定时间后更新值,并带有控制功能。

演示

就绪: false

用法

ts
import { 
useTimeout
} from '@vueuse/core'
const
ready
=
useTimeout
(1000)
ts
const { 
ready
,
start
,
stop
} =
useTimeout
(1000, {
controls
: true })
ts
import { 
promiseTimeout
} from '@vueuse/core'
console
.
log
(ready.value) // false
await
promiseTimeout
(1200)
console
.
log
(ready.value) // true

类型声明

ts
export interface 
UseTimeoutOptions
<
Controls
extends boolean>
extends UseTimeoutFnOptions { /** * Expose more controls * * @default false */
controls
?:
Controls
/** * Callback on timeout */
callback
?:
Fn
} export type
UseTimoutReturn
=
|
ComputedRef
<boolean>
| ({ readonly
ready
:
ComputedRef
<boolean>
} &
Stoppable
)
/** * Update value after a given time with controls. * * @see {@link https://vueuse.org.cn/useTimeout} * @param interval * @param options */ export declare function
useTimeout
(
interval
?:
MaybeRefOrGetter
<number>,
options
?:
UseTimeoutOptions
<false>,
):
ComputedRef
<boolean>
export declare function
useTimeout
(
interval
:
MaybeRefOrGetter
<number>,
options
:
UseTimeoutOptions
<true>,
): {
ready
:
ComputedRef
<boolean>
} &
Stoppable

来源

源文件演示文档

贡献者

Anthony Fu
Anthony Fu
NoiseFan
SerKo
Robin
IlyaL
OrbisK
huiliangShen
Waleed Khaled
vaakian X
Jelf
Shinigami
Mark Noonan

更新日志

v13.1.0
c1d6e - feat(shared): 确保返回类型存在 (#4659)
v12.8.0
7432f - feat(types): 废弃 MaybeRefMaybeRefOrGetter,转而使用 Vue 的原生类型 (#4636)
0a9ed - feat!: 放弃对 Vue 2 的支持,优化打包并清理 (#4349)
4eede - feat: target support reactivity (#3923)

根据 MIT 许可证发布。