Skip to content
On this page

useAverage

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 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>
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: MaybeComputedRef<MaybeComputedRef<number>[]>
): ComputedRef<number>
export declare function useAverage(
  ...args: MaybeComputedRef<number>[]
): ComputedRef<number>
export declare function useAverage(
  array: MaybeComputedRef<MaybeComputedRef<number>[]>
): ComputedRef<number>
export declare function useAverage(
  ...args: MaybeComputedRef<number>[]
): ComputedRef<number>

Source

Category
Package
@vueuse/math
Last Changed
last month

SourceDocs

Contributors

Changelog

No recent changes

Released under the MIT License.