Skip to content

refDefault

Category
Export Size
140 B
Last Changed
3 months ago

Apply default value to a ref.

Usage

ts
import { 
refDefault
,
useStorage
} from '@vueuse/core'
const
raw
=
useStorage
('key')
const
state
=
refDefault
(
raw
, 'default')
raw
.
value
= 'hello'
console
.
log
(
state
.
value
) // hello
raw
.
value
=
undefined
console
.
log
(
state
.
value
) // default

Type Declarations

ts
/**
 * Apply default value to a ref.
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function 
refDefault
<
T
>(
source
:
Ref
<
T
| undefined | null>,
defaultValue
:
T
,
):
Ref
<
T
>

Source

SourceDocs

Contributors

Anthony Fu
SerKo

Changelog

v13.6.0 on
d32f8 - refactor: add @__NO_SIDE_EFFECTS__ annotations to all pure functions (#4907)
v12.0.0-beta.1 on
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)

Released under the MIT License.

FREE WEEKEND
Unlimited access to ALL Vue School courses
8-9 November 2025
Reserve Your Spot
8-9 November 2025