Fleshing out the documentation

This commit is contained in:
2023-08-21 11:53:23 +02:00
parent 1e5749ee85
commit f2b7934239
5 changed files with 83 additions and 8 deletions

View File

@ -842,7 +842,7 @@ export class UserAPI {
return Math.random() > 0.5;
};
min = (...values: number[]): number => {
public min = (...values: number[]): number => {
/**
* Returns the minimum value of a list of numbers.
*
@ -852,7 +852,7 @@ export class UserAPI {
return Math.min(...values);
};
max = (...values: number[]): number => {
public max = (...values: number[]): number => {
/**
* Returns the maximum value of a list of numbers.
*
@ -862,6 +862,20 @@ export class UserAPI {
return Math.max(...values);
};
public mean = (...values: number[]): number => {
/**
* Returns the mean of a list of numbers.
*
* @param values - The list of numbers
* @returns The mean value of the list of numbers
*/
const sum = values.reduce(
(accumulator, currentValue) => accumulator + currentValue,
0
);
return sum / values.length;
};
limit = (value: number, min: number, max: number): number => {
/**
* Limits a value between a minimum and a maximum.