17 lines
480 B
TypeScript
17 lines
480 B
TypeScript
//#region src/math/mean.d.ts
|
|
/**
|
|
* Calculates the average of an array of numbers.
|
|
*
|
|
* If the array is empty, this function returns `NaN`.
|
|
*
|
|
* @param {number[]} nums - An array of numbers to calculate the average.
|
|
* @returns {number} The average of all the numbers in the array.
|
|
*
|
|
* @example
|
|
* const numbers = [1, 2, 3, 4, 5];
|
|
* const result = mean(numbers);
|
|
* // result will be 3
|
|
*/
|
|
declare function mean(nums: readonly number[]): number;
|
|
//#endregion
|
|
export { mean }; |