useSum

v0.0.15testeddemo

Reactively compute the sum 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.

Source Tests

Examples

const a = ref(1);
const b = ref(3);
const total = useSum(a, b, 2); // 6

const list = ref([1, 5, 2]);
const total = useSum(list); // 8

const list = ref([ref(1), () => 5, 2]);
const total = useSum(list); // 8

Demo

Loading demo…

Signatures

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

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

Parameters

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

Returns

ComputedRef<number>A computed ref of the total (`0` when empty)