Skip to content

refManualReset

类别
导出体积
上次更改
5 days ago
别名
manualResetRef

Create a ref with manual reset functionality.

示例

Usage

ts
import { 
refManualReset
} from '@vueuse/core'
const
message
=
refManualReset
('default message')
message
.
value
= 'message has set'
message
.
reset
()
console
.
log
(
message
.
value
) // 'default message'

类型声明

ts
/**
 * 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
>

源码

源码演示文档

贡献者

phk422

更新日志

81bb3 - feat: new function (#4644)