refAutoReset

一段时间后将重置为默认值的参考。

¥A ref which will be reset to the default value after some time.

示例

源代码演练场

Default message

用法

¥Usage

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 来触发效果。

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

类型声明

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/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>
export { refAutoReset as autoResetRef }

源代码

源代码 • 示例 • 文档

变更日志

v13.4.0 on

319d8 - feat(shared): Introduce TimerHandle for setTimeout type (#4801)