Skip to content

mean

Import from @varavel/vdl-plugin-sdk/utils/math.

function mean(nums): number;

Calculates the average of an array of numbers.

If the array is empty, this function returns NaN.

Parameters

Parameter Type Description
nums readonly number[] 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