useCached

v0.0.1testeddemo

Caches the value of an external ref and updates it only when the value changes

Examples

const externalValue = ref(0);
const cachedValue = useCached(externalValue);

const externalValue = ref(0);
const cachedValue = useCached(externalValue, (a, b) => a === b, { immediate: true });

Demo

Loading demo…

Signature

export function useCached<Value = unknown>(
  externalValue: MaybeRefOrGetter<Value>,
  comparator: Comparator<Value> = (a, b) => a === b,
  watchOptions?: WatchOptions,
): Ref<Value>{ ... }

Type Parameters

Value= unknown

Parameters

Parameter	Type	Default	Description
`externalValue`	`MaybeRefOrGetter<Value>`	—	Ref to cache
`comparator`?	`Comparator<Value>`	`(a, b) => a === b`	Comparator function to compare the values
`watchOptions`?	`WatchOptions<boolean> \| undefined`	—	Watch options

Returns

Ref<Value, Value>Cached ref