useCached

Category

Utilities

Export Size

169 B

Last Changed

last month

Cache a ref with a custom comparator.

Demo

source

Value: 42

Extra: 0

Cached Value: 42

Cached Extra: 0

Temp Value:

Local Extra:

Usage

TypeScript

import { useCached } from '@vueuse/core'

interface Data {
  value: number
  extra: number
}

const source = ref<Data>({ value: 42, extra: 0 })
const cached = useCached(source, (a, b) => a.value === b.value)

source.value = {
  value: 42,
  extra: 1,
}

console.log(cached.value) // { value: 42, extra: 0 }

source.value = {
  value: 43,
  extra: 1,
}

console.log(cached.value) // { value: 43, extra: 1 }

import { useCached } from '@vueuse/core'
const source = ref({ value: 42, extra: 0 })
const cached = useCached(source, (a, b) => a.value === b.value)
source.value = {
  value: 42,
  extra: 1,
}
console.log(cached.value) // { value: 42, extra: 0 }
source.value = {
  value: 43,
  extra: 1,
}
console.log(cached.value) // { value: 43, extra: 1 }

Type Declarations

export declare function useCached<T>(
  refValue: Ref<T>,
  comparator?: (a: T, b: T) => boolean,
  watchOptions?: WatchOptions,
): Ref<T>

Source

Source • Demo • Docs

Contributors

Anthony Fu

Anthony Fu

sun0day

lvjiaxuan

Wenlu Wang

Changelog

v12.0.0-beta.1 on 11/21/2024

0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)