math | jslib-utils

Index

Variables

defaultDictionary

Functions

Variables

Private Const defaultDictionary

defaultDictionary: "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ" = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"

Functions

clamp

clamp(value: number, min: number | null | undefined, max: number | null | undefined): number

- Defined in math/clamp.ts:20
Returns a value clamped between a maximum and a minimum number.
example
```
clamp(5, 0, 10); // Returns 5
clamp(-10, 0, 10); // Returns 0
clamp(20, 0, 10); // Returns 10
```
Parameters
- value: number
  
  The value to clamp.
- min: number | null | undefined
  
  The minimum boundary.
- max: number | null | undefined
  
  The maximum boundary.
Returns number

clampMax

clampMax(max: number | null | undefined, value: number): number

- Defined in math/clampMax.ts:7
Parameters
- max: number | null | undefined
- value: number
Returns number

clampMin

clampMin(min: number | null | undefined, value: number): number

- Defined in math/clampMin.ts:7
Parameters
- min: number | null | undefined
- value: number
Returns number

decimalPlaces

decimalPlaces(value: number | string): number

- Defined in math/decimalPlaces.ts:11
Computes the amount of decimals of a number. Note: Will drop trailing zeroes off a numeric value. 1.00 => 0 decimals '1.00' => 2 decimals.

Parameters
- value: number | string
  
  A value as a number or a string.
Returns number

degreeToRadian

degreeToRadian(degree: number): number

- Defined in math/degreeToRadian.ts:8
Converts degrees to radians.

Parameters
- degree: number
  
  A number representing the degrees to convert.
Returns number

inRange

inRange(value: number, min: number, max: number, threshold?: number): boolean

- Defined in math/inRange.ts:13
Checks if value is inside a range.

Parameters
- value: number
  
  Value to check.
- min: number
  
  Range minimum boundary.
- max: number
  
  Range maximum boundary.
- Default value threshold: number = 0
  
  Optional threshold value.
Returns boolean

lerp

lerp(start: number, end: number, t: number): number

- Defined in math/lerp.ts:10
Linear interpolation.

Parameters
- start: number
  
  Start value;
- end: number
  
  End value.
- t: number
  
  A value in the set [0, 1].
Returns number

mapToRange

mapToRange(value: number, inStart: number, inEnd: number, outStart: number, outEnd: number): number

- Defined in math/mapToRange.ts:12
Maps a value from an input range to an output range.

Parameters
- value: number
  
  The value to map.
- inStart: number
  
  In start value.
- inEnd: number
  
  In end value.
- outStart: number
  
  Out start value.
- outEnd: number
  
  Out end value.
Returns number

radianToDegree

radianToDegree(radian: number): number

- Defined in math/radianToDegree.ts:8
Converts radians to degrees.

Parameters
- radian: number
  
  A number representing the radians to
Returns number

randomInt

randomInt(min: number, max: number): number

- Defined in math/randomInt.ts:10
Returns a random integer inside range or snap to min/max values.

Parameters
- min: number
  
  Minimum value.
- max: number
  
  Maximum value.
Returns number

randomRange

randomRange(min: number | null | undefined, max: number | null | undefined): number

- Defined in math/randomRange.ts:11
Returns a pseudo-random number between a min (inclusive) and a max (exclusive) value.

If min is greater than max the parameters are swapped to support inverted ranges.

Parameters
- min: number | null | undefined
  
  The minimum value of the range.
- max: number | null | undefined
  
  The maximum value of the range.
Returns number

randomString

randomString(length: number, dictionary?: string): string

- Defined in math/randomString.ts:14
Returns a random string of the specified length.

Parameters
- length: number
  
  Length.
- Default value dictionary: string = defaultDictionary
  
  A string containing all the symbols to choose from.
Returns string

round

round(value: number, radix?: number): number

- Defined in math/round.ts:10
Rounds number to a specific radix.

Parameters
- value: number
  
  Value to round.
- Default value radix: number = 1
  
  Radix.
Returns number

wrap

wrap(value: number, min: number, max: number): number

- Defined in math/wrap.ts:10
Wraps a value within a range.

Parameters
- value: number
  
  The value to wrap.
- min: number
  
  The minimum boundary.
- max: number
  
  The maximum boundary.
Returns number

Generated using TypeDoc