4a3ce4cc1d
Add comprehensive reference documentation for: - Vitest: environments, projects/workspaces, type testing, vi utilities - Pinia: HMR, Nuxt integration, SSR setup - Vue: built-in components (Transition, Teleport, Suspense, KeepAlive) and advanced directives
1.2 KiB
1.2 KiB
category
| category |
|---|
| Reactivity |
createRef
Returns a deepRef or shallowRef depending on the deep param.
Usage
import { createRef } from '@vueuse/core'
import { isShallow, ref } from 'vue'
const initialData = 1
const shallowData = createRef(initialData)
const deepData = createRef(initialData, true)
isShallow(shallowData) // true
isShallow(deepData) // false
Type Declarations
export type CreateRefReturn<
T = any,
D extends boolean = false,
> = ShallowOrDeepRef<T, D>
export type ShallowOrDeepRef<
T = any,
D extends boolean = false,
> = D extends true ? Ref<T> : ShallowRef<T>
/**
* Returns a `deepRef` or `shallowRef` depending on the `deep` param.
*
* @example createRef(1) // ShallowRef<number>
* @example createRef(1, false) // ShallowRef<number>
* @example createRef(1, true) // Ref<number>
* @example createRef("string") // ShallowRef<string>
* @example createRef<"A"|"B">("A", true) // Ref<"A"|"B">
*
* @param value
* @param deep
* @returns the `deepRef` or `shallowRef`
*
* @__NO_SIDE_EFFECTS__
*/
export declare function createRef<T = any, D extends boolean = false>(
value: T,
deep?: D,
): CreateRefReturn<T, D>