refAutoReset

分类

响应性

导出大小

236 B

上次更改

上个月

别名

autoResetRef

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

演示

源代码演练场 (beta)

默认消息

用法

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

类型声明

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