W3cubDocs

/VueUse

useAverage

Category @Math

Export Size 195 B

Package @vueuse/math

Last Changed 2 weeks ago

Category	@Math
Export Size	195 B
Package	`@vueuse/math`
Last Changed	2 weeks ago

Get the average of an array reactively.

Usage

import { useAverage } from '@vueuse/math'

const list = ref([1, 2, 3])
const averageValue = useAverage(list) // Ref<2>

import { useAverage } from '@vueuse/math'

const a = ref(1)
const b = ref(3)

const averageValue = useAverage(a, b) // Ref<2>

Type Declarations

export declare function useAverage(
  array: MaybeRefOrGetter<MaybeRefOrGetter<number>[]>
): ComputedRef<number>
export declare function useAverage(
  ...args: MaybeRefOrGetter<number>[]
): ComputedRef<number>

Source

Source • Docs