vue-lynx / shallowRef

Function: shallowRef()

shallowRef(value)

function shallowRef<T>(value): Ref extends T ? T extends Ref ? IfAny<T, ShallowRef<T>, T> : ShallowRef<T> : ShallowRef<T>

Shallow version of ref.

Type Parameters

Type Parameter
T

Parameters

ParameterTypeDescription
valueTThe "inner value" for the shallow ref.

Returns

Ref extends T ? T extends Ref ? IfAny<T, ShallowRef<T>, T> : ShallowRef<T> : ShallowRef<T>

Example

const state = shallowRef({ count: 1 })

// does NOT trigger change
state.value.count = 2

// does trigger change
state.value = { count: 2 }

See

https://vuejs.org/api/reactivity-advanced.html#shallowref

Defined in

node_modules/.pnpm/@vue+reactivity@3.5.30/node_modules/@vue/reactivity/dist/reactivity.d.ts:463

shallowRef()

function shallowRef<T>(): ShallowRef<T | undefined>

Type Parameters

Type ParameterDefault type
Tany

Returns

ShallowRef<T | undefined>

Defined in

node_modules/.pnpm/@vue+reactivity@3.5.30/node_modules/@vue/reactivity/dist/reactivity.d.ts:464