Skip to content

refAutoReset

类别
导出体积
255 B
上次更改
5 days ago
别名
autoResetRef

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

示例

Default message

用法

ts
import { refAutoReset } from '@vueuse/core'

const message = refAutoReset('默认消息', 1000)

function setMessage() {
  // 在这里,值将会变为 '消息已设置',但是 1000 毫秒后,它将会变回 '默认消息'
  message.value = '消息已设置'
}

INFO

You can use triggerRef to trigger effects after making deep mutations to the inner value of a refAutoReset.

类型声明

typescript
export type RefAutoResetReturn<T = any> = Ref<T>
/**
 * 一个在一段时间后将重置为默认值的 ref。
 *
 * @see https://vueuse.org/refAutoReset
 * @param defaultValue 将要设置的值。
 * @param afterMs      延迟时间 (以毫秒为单位)。
 */
export declare function refAutoReset<T>(
  defaultValue: MaybeRefOrGetter<T>,
  afterMs?: MaybeRefOrGetter<number>,
): RefAutoResetReturn<T>
export { refAutoReset as autoResetRef }

源码

源码演示文档

贡献者

Anthony Fu
一纸忘忧
Anthony Fu
IlyaL
Robin
OrbisK
moander
sun0day
wheat
Kasper Seweryn

更新日志

c1d6e - feat(shared): ensure return types exists (#4659)
7432f - feat(types): deprecate MaybeRef and MaybeRefOrGetter in favor of Vue's native (#4636)
59f75 - feat(toValue): deprecate toValue from @vueuse/shared in favor of Vue's native
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)
71685 - feat: support maybe-ref as value (#3342)
4d757 - feat(types)!: rename MaybeComputedRef to MaybeRefOrGetter
0a72b - feat(toValue): rename resolveUnref to toValue