refManualReset

Category

Reactivity

Export Size

Last Changed

5 hours ago

Alias

manualResetRef

Create a ref with manual reset functionality.

Demo

sourceplayground (beta)

Usage

import { refManualReset } from '@vueuse/core'

const message = refManualReset('default message')

message.value = 'message has set'

message.reset()

console.log(message.value) // 'default message'

Type Declarations

/**
 * Define the shape of a ref that supports manual reset functionality.
 *
 * This interface extends the standard `Ref` type from Vue and adds a `reset` method.
 * The `reset` method allows the ref to be manually reset to its default value.
 */
export interface ManualResetRefReturn<T> extends Ref<T> {
  reset: Fn
}
/**
 * Create a ref with manual reset functionality.
 *
 * @see https://vueuse.org/refManualReset
 * @param defaultValue The value which will be set.
 */
export declare function refManualReset<T>(
  defaultValue: MaybeRefOrGetter<T>,
): ManualResetRefReturn<T>

Source

Source • Demo • Docs

Contributors

phk422

Changelog

Pending for release...

81bb3 - feat: new function (#4644)