@modern-kit/utils/dist/math/average/index.d.ts

modern-kit/utils

/**
 * @description 숫자 배열의 모든 요소를 합산하여 평균을 구하는 함수
 *
 * @param {number[] | readonly number[]} arr - 숫자 배열
 * @returns {number} 배열의 모든 숫자의 평균
 *
 * @example
 * average([1, 2, 3]); // 2
 */
declare function average(arr: number[] | readonly number[]): number;
/**
 * @description 배열의 모든 요소를 iteratee 함수를 기반으로 합산하여 평균을 구하는 함수
 *
 * @template T - 배열 요소의 타입
 * @param {T[] | readonly T[]} arr - 배열
 * @param {(item: T) => number} iteratee - 배열 요소를 처리하는 함수
 * @returns {number} 배열의 모든 숫자의 평균
 *
 * @example
 * average([{ value : 1 }, { value : 2 }, { value : 3 }], (item) => item.value); // 2
 */
declare function average<T>(arr: T[] | readonly T[], iteratee: (item: T) => number): number;

export { average };