useAverage

v0.0.15testeddemo

Reactively compute the average (arithmetic mean) of the provided numbers. Accepts either a variadic list of numbers (each a ref, getter, or raw value) or a single reactive array whose items may themselves be refs/getters. Returns `NaN` when there are no values, mirroring `0 / 0`.

Source Tests

Examples

const a = ref(1);
const b = ref(3);
const avg = useAverage(a, b, 2); // 2

const list = ref([1, 5, 3]);
const avg = useAverage(list); // 3

const list = ref([ref(2), () => 4, 6]);
const avg = useAverage(list); // 4

Demo

Loading demo…

Signatures

export function useAverage(array: MaybeRefOrGetter<Array<MaybeRefOrGetter<number>>>): ComputedRef<number>;

export function useAverage(...args: Array<MaybeRefOrGetter<number>>): ComputedRef<number>;

Parameters

Parameter	Type	Default	Description
`args`?	`MaybeComputedRefArgs<number>`	—	The values to average, or a single reactive array of values

Returns

ComputedRef<number>A computed ref of the mean (`NaN` when empty)