Skip to main content

average

배열 요소의 합의 평균을 반환합니다.

기본적으로 숫자 배열의 평균을 반환하며, 그 외 타입의 배열은 두 번째 인자인 iteratee 함수 결과를 토대로 평균을 얻을 수 있습니다.

만약, 빈 배열([])의 경우에는 0을 반환합니다.


Code​

🔗 실제 구현 코드 확인

Interface​

typescript
// 함수 오버로딩
function average<T extends number>(arr: T[] | readonly T[]): T;
function average<T>(
  arr: T[] | readonly T[],
  iteratee: (item: T) => number
): T;

Usage​

Default​

typescript
import { average } from '@modern-kit/utils';

const arr = [1, 2, 3, 4, 5];
const result = average(arr); // 3

Iteratee​

typescript
import { average } from '@modern-kit/utils';

const arr = [
  { value: 1 },
  { value: 2 },
  { value: 3 },
  { value: 4 },
  { value: 5 },
];
const result = average(arr, (item) => item.value); // 3