跳到主要内容

refAutoReset

分类
导出大小
236 B
上次更改
上个月
别名
autoResetRef

一个在一段时间后会自动重置为默认值的 ref。

演示

默认消息

用法

ts
import { 
refAutoReset
} from '@vueuse/core'
const
message
=
refAutoReset
('default message', 1000)
function
setMessage
() {
// here the value will change to 'message has set' but after 1000ms, it will change to 'default message'
message
.
value
= 'message has set'
}

信息

在对 refAutoReset 的内部值进行深度修改后,您可以使用 triggerRef 来触发效果。

类型声明

ts
export type 
RefAutoResetReturn
<
T
= any> =
Ref
<
T
>
/** * Create a ref which will be reset to the default value after some time. * * @see https://vueuse.org.cn/refAutoReset * @param defaultValue The value which will be set. * @param afterMs A zero-or-greater delay in milliseconds. */ export declare function
refAutoReset
<
T
>(
defaultValue
:
MaybeRefOrGetter
<
T
>,
afterMs
?:
MaybeRefOrGetter
<number>,
):
RefAutoResetReturn
<
T
>
/** @deprecated use `refAutoReset` instead */ export declare const
autoResetRef
: typeof
refAutoReset

来源

源文件演示文档

贡献者

Anthony Fu
Anthony Fu
IlyaL
NoiseFan
Vida Xie
IlyaL
Robin
OrbisK
moander
sun0day
wheat
Kasper Seweryn

更新日志

e5f74 - feat!: 弃用别名导出,转而使用原始函数名称 (#5009)
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.3.0
59f75 - feat(toValue): 废弃 @vueuse/shared 中的 toValue,转而使用 Vue 的原生函数
0a9ed - feat!: 放弃对 Vue 2 的支持,优化打包并清理 (#4349)
v10.4.0
71685 - feat: 支持 maybe-ref 作为值 (#3342)

根据 MIT 许可证发布。