1---
2category: Reactivity
3---
4 
5# createRef
6 
7Returns a `deepRef` or `shallowRef` depending on the `deep` param.
8 
9## Usage
10 
11```ts
12import { createRef } from '@vueuse/core'
13import { isShallow, ref } from 'vue'
14 
15const initialData = 1
16 
17const shallowData = createRef(initialData)
18const deepData = createRef(initialData, true)
19 
20isShallow(shallowData) // true
21isShallow(deepData) // false
22```
23 
24## Type Declarations
25 
26```ts
27export type CreateRefReturn<
28  T = any,
29  D extends boolean = false,
30> = ShallowOrDeepRef<T, D>
31export type ShallowOrDeepRef<
32  T = any,
33  D extends boolean = false,
34> = D extends true ? Ref<T> : ShallowRef<T>
35/**
36 * Returns a `deepRef` or `shallowRef` depending on the `deep` param.
37 *
38 * @example createRef(1) // ShallowRef<number>
39 * @example createRef(1, false) // ShallowRef<number>
40 * @example createRef(1, true) // Ref<number>
41 * @example createRef("string") // ShallowRef<string>
42 * @example createRef<"A"|"B">("A", true) // Ref<"A"|"B">
43 *
44 * @param value
45 * @param deep
46 * @returns the `deepRef` or `shallowRef`
47 *
48 * @__NO_SIDE_EFFECTS__
49 */
50export declare function createRef<T = any, D extends boolean = false>(
51  value: T,
52  deep?: D,
53): CreateRefReturn<T, D>
54```
55