useArrayReduce

分类

导出大小

183 B

上次更改

3 个月前

响应式的 Array.reduce。

用法

import { useArrayReduce
 } from '@vueuse/core'

const sum
 = useArrayReduce
([ref
(1), ref
(2), ref
(3)], (sum
, val
) => sum
 + val
)
// sum.value: 6

与响应式数组一起使用

import { useArrayReduce
 } from '@vueuse/core'

const list
 = reactive
([1, 2])
const sum
 = useArrayReduce
(list
, (sum
, val
) => sum
 + val
)

list
.push
(3)
// sum.value: 6

与 initialValue 一起使用

import { useArrayReduce
 } from '@vueuse/core'

const list
 = reactive
([{ num
: 1 }, { num
: 2 }])
const sum
 = useArrayReduce
(list
, (sum
, val
) => sum
 + val
.num
, 0)
// sum.value: 3

类型声明

显示类型声明

export type UseArrayReducer
<PV
, CV
, R
> = (
  previousValue
: PV
,
  currentValue
: CV
,
  currentIndex
: number,
) => R

/**
 * Reactive `Array.reduce`
 *
 * @see https://vueuse.org.cn/useArrayReduce
 * @param list - the array was called upon.
 * @param reducer - a "reducer" function.
 *
 * @returns the value that results from running the "reducer" callback function to completion over the entire array.
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function useArrayReduce
<T
>(
  list
: MaybeRefOrGetter
<MaybeRefOrGetter
<T
>[]>,
  reducer
: UseArrayReducer
<T
, T
, T
>,
): ComputedRef
<T
>
/**
 * Reactive `Array.reduce`
 *
 * @see https://vueuse.org.cn/useArrayReduce
 * @param list - the array was called upon.
 * @param reducer - a "reducer" function.
 * @param initialValue - a value to be initialized the first time when the callback is called.
 *
 * @returns the value that results from running the "reducer" callback function to completion over the entire array.
 *
 * @__NO_SIDE_EFFECTS__
 */
export declare function useArrayReduce
<T
, U
>(
  list
: MaybeRefOrGetter
<MaybeRefOrGetter
<T
>[]>,
  reducer
: UseArrayReducer
<U
, T
, U
>,
  initialValue
: MaybeRefOrGetter
<U
>,
): ComputedRef
<U
>