refAutoReset

类别

Reactivity

导出体积

236 B

上次更改

6 minutes ago

别名

autoResetRef

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

示例

源码 playground (beta)

Default message

用法

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.

类型声明

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
>
/** @deprecated use `refAutoReset` instead */
export declare const autoResetRef
: typeof refAutoReset