Skip to content

refAutoReset ​

Category
Export Size
234 B
Last Changed
7 months ago
Alias
autoResetRef

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

Demo ​

Default message

Usage ​

ts
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 ​

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

Source ​

Source • Demo • Docs

Contributors ​

Anthony Fu
moander
sun0day
wheat
Kasper Seweryn

Changelog ​

v10.4.0 on 8/25/2023
71685 - feat: support maybe-ref as value (#3342)
v10.0.0-beta.4 on 4/13/2023
4d757 - feat(types)!: rename MaybeComputedRef to MaybeRefOrGetter
0a72b - feat(toValue): rename resolveUnref to toValue
v9.1.1 on 8/23/2022
0fdbb - fix(shared): resolve internal circular reference

Released under the MIT License.