Skip to content
On this page

refAutoReset

Category
Last Changed
last month
Alias
autoResetRef

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

Demo

Default message

Usage

import { refAutoReset } from '@vueuse/core'

const message = refAutoReset('default message', 1000)

const setMessage = () => {
  // here the value will change to 'message has set' but after 1000ms, it will change to 'default message'
  message.value = 'message has set'
}
import { refAutoReset } from '@vueuse/core'

const message = refAutoReset('default message', 1000)

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

Source

SourceDemoDocs

Contributors

Anthony Fu
wheat
Kasper Seweryn

Changelog

v8.3.0 on 4/20/2022
8843f - fix: clear timeout on scope dispose (#1507)
refAutoReset has loaded