W3cubDocs

/VueUse

refAutoReset

Category Reactivity

Export Size 234 B

Last Changed 2 weeks ago

Alias autoResetRef

Category	Reactivity
Export Size	234 B
Last Changed	2 weeks ago
Alias	`autoResetRef`

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

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'
}

Type Declarations

/**
 * 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: T,
  afterMs?: MaybeRefOrGetter<number>
): Ref<T>
export { refAutoReset as autoResetRef }

Source

Source • Demo • Docs