feat .calude

.claude/skills/vueuse-functions/references/createRef.md

@@ -0,0 +1,54 @@
+---
+category: Reactivity
+---
+
+# createRef
+
+Returns a `deepRef` or `shallowRef` depending on the `deep` param.
+
+## Usage
+
+```ts
+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
+
+```ts
+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>
+```