R
fn

useArrayReduce

v0.0.15testeddemo

Reactive `Array.prototype.reduce`, with an optional initial value.

Example

ts
const list = ref([1, 2, 3, 4]);
const sum = useArrayReduce(list, (acc, n) => acc + n); // 10

Demo

Loading demo…

Signatures

ts
export function useArrayReduce<T>(
  list: MaybeRefOrGetter<Array<MaybeRefOrGetter<T>>>,
  reducer: UseArrayReducer<T, T, T>,
): UseArrayReduceReturn<T>;
ts
export function useArrayReduce<T, U>(
  list: MaybeRefOrGetter<Array<MaybeRefOrGetter<T>>>,
  reducer: UseArrayReducer<U, T, U>,
  initialValue: MaybeRefOrGetter<U>,
): UseArrayReduceReturn<U>;

Type Parameters

T
U

Parameters

ParameterTypeDescription
listMaybeRefOrGetter<MaybeRefOrGetter<T>[]>The source array (items can be reactive)
reducerUseArrayReducer<U, T, U>A reducer callback applied to each element
initialValue?MaybeRefOrGetter<U> | undefined

Returns

UseArrayReduceReturn<U>The reduced value