Skip to main content

@rtorcato/js-common / numbers

numbers

Functions​

clamp()​

clamp(value, min, max): number

Defined in: numbers/index.ts:16

Clamps a number between a minimum and maximum value.

Example​

clamp(15, 0, 10) // 10
clamp(-5, 0, 10) // 0
clamp(5, 0, 10) // 5

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:34

Rounds a number to a specified number of decimal places.

Example​

roundTo(3.14159) // 3.14
roundTo(3.14159, 3) // 3.142
roundTo(1234.5, 0) // 1235

Parameters​

value​

number

The number to round.

decimals?​

number = 2

The number of decimal places. Defaults to 2.

Returns​

number

The rounded number.

formatPercent()​

formatPercent(value, fractionDigits?): string

Defined in: numbers/index.ts:52

Formats a number as a percentage string.

Example​

formatPercent(0.25) // '25%'
formatPercent(0.1234, 1) // '12.3%'

Parameters​

value​

number

The value to format (e.g. 0.25 for 25%).

fractionDigits?​

number = 0

Number of decimal places (default: 0).

Returns​

string

The formatted percentage string.

between()​

between(value, min, max, inclusive?): boolean

Defined in: numbers/index.ts:64

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:73

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:82

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:92

Returns the true mathematical modulus, handling negative numbers correctly.

Parameters​

n​

number

The dividend.

m​

number

The divisor.

Returns​

number

The modulus result.