Skip to content
On this page

useAverage

Category
Export Size
273 B
Package
@vueuse/math
Last Changed
4 months ago

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>
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>
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: 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

SourceDocs

Contributors

Anthony Fu
Lynch

Changelog

v8.9.3 on 7/14/2022
8afa6 - feat: support rest usage
v8.9.2 on 7/12/2022
9b071 - feat: new function (#1826)

Released under the MIT License.