@rtorcato/js-common / numbers
numbers
Functions
getRandomInt()
getRandomInt(
min,max):number
Defined in: numbers/index.ts:7
Returns a random integer between min and max (inclusive).
Parameters
min
number
The minimum value (inclusive).
max
number
The maximum value (inclusive).
Returns
number
A random integer.
clamp()
clamp(
value,min,max):number
Defined in: numbers/index.ts:18
Clamps a number between a minimum and maximum value.
Parameters
value
number
The number to clamp.
min
number
The minimum value.
max
number
The maximum value.
Returns
number
The clamped value.
roundTo()
roundTo(
value,decimals?):number
Defined in: numbers/index.ts:28
Rounds a number to a specified number of decimal places.
Parameters
value
number
The number to round.
decimals?
number = 2
The number of decimal places. Defaults to 2.
Returns
number
The rounded number.
isFiniteNumber()
isFiniteNumber(
value):value is number
Defined in: numbers/index.ts:38
Checks if a value is a finite number.
Parameters
value
unknown
The value to check.
Returns
value is number
True if the value is a finite number, false otherwise.
getRandomFloat()
getRandomFloat(
min,max):number
Defined in: numbers/index.ts:48
Generates a random float between min (inclusive) and max (exclusive).
Parameters
min
number
The minimum value (inclusive).
max
number
The maximum value (exclusive).
Returns
number
A random float.
isInteger()
isInteger(
value):value is number
Defined in: numbers/index.ts:57
Checks if a value is an integer.
Parameters
value
unknown
The value to check.
Returns
value is number
True if the value is an integer, false otherwise.
between()
between(
value,min,max,inclusive?):boolean
Defined in: numbers/index.ts:69
Checks if a number is between two values.
Parameters
value
number
The number to check.
min
number
The minimum value.
max
number
The maximum value.
inclusive?
boolean = true
Whether the range is inclusive (default: true).
Returns
boolean
True if the number is between min and max, false otherwise.
sum()
sum(
numbers):number
Defined in: numbers/index.ts:78
Returns the sum of an array of numbers.
Parameters
numbers
number[]
The array of numbers to sum.
Returns
number
The sum of the numbers.
average()
average(
numbers):number
Defined in: numbers/index.ts:87
Returns the average of an array of numbers.
Parameters
numbers
number[]
The array of numbers.
Returns
number
The average value, or 0 if the array is empty.
mod()
mod(
n,m):number
Defined in: numbers/index.ts:97
Returns the true mathematical modulus, handling negative numbers correctly.
Parameters
n
number
The dividend.
m
number
The divisor.
Returns
number
The modulus result.
min()
min(
numbers):number
Defined in: numbers/index.ts:106
Returns the smallest value in an array of numbers.
Parameters
numbers
number[]
The array of numbers.
Returns
number
The minimum value.
max()
max(
numbers):number
Defined in: numbers/index.ts:115
Returns the largest value in an array of numbers.
Parameters
numbers
number[]
The array of numbers.
Returns
number
The maximum value.