@feds01/graphika

---

@feds01/graphika / utils/number

utils/number

Functions

clamp()

function clamp(
   num, 
   min, 
   max): number;

Defined in: utils/number.ts:22

Returns a number whose value is limited to the given range.

Parameters

Parameter	Type	Description
num	number	-
min	number	The lower boundary of the output range.
max	number	The upper boundary of the output range.

Returns

number

A number in the range [min, max].

---

floor()

function floor(num, dp): number;

Defined in: utils/number.ts:49

Function to floor a number to the nearest boundary. For example, floor a 5 to a boundary of 8 would round the number to 0. Flooring 11 with boundary of 8 would floor it to 8.

Parameters

Parameter	Type	Description
num	number	A number that is to be floored to the nearest number (with the same parity as the specified boundary).
dp	number	-

Returns

number

the original number that is floored.

---

isNum()

function isNum(o): o is number;

Defined in: utils/number.ts:58

Check if the given object is a number and is not NaN.

Parameters

Parameter	Type	Description
o	unknown	The object to check if it is a number.

Returns

o is number

---

round()

function round(num, bound): number;

Defined in: utils/number.ts:34

Function to round a number to the nearest boundary. For example, round a 5 to a boundary of 8 would round the number to 8. Rounding the number 11 with a boundary of 8 would round the number down to 8.

Parameters

Parameter	Type	Description
num	number	A number that is to be rounded to the nearest number (with the same parity as the specified boundary).
bound	number	The specified boundary that the number should be rounded to.

Returns

number