Skip to content
On this page

refDefault

Category
Last Changed
3 months ago

Apply default value to a ref.

Usage

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

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

Source

SourceDocs

Contributors

Anthony Fu

Changelog

v6.6.0 on 10/16/2021
9b409 - feat: new function
refDefault has loaded