Skip to content

useAverage

Category
Export Size
195 B
Package
@vueuse/math
Last Changed
last year

Get the average of an array reactively.

Usage

ts
import { useAverage } from '@vueuse/math'

const list = ref([1, 2, 3])
const averageValue = useAverage(list) // Ref<2>
ts
import { useAverage } from '@vueuse/math'

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

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

Type Declarations

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

Source

SourceDocs

Contributors

Anthony Fu
Lynch

Changelog

v10.0.0-beta.4 on 4/13/2023
4d757 - feat(types)!: rename MaybeComputedRef to MaybeRefOrGetter
0a72b - feat(toValue): rename resolveUnref to toValue
v8.9.3 on 7/14/2022
8afa6 - feat: support rest usage

Released under the MIT License.