JSDoc: Namespace: Number

Properties:

Name Type Description

aidsIn

function

The Number class

Properties

Name	Type	Description
`prototype`	Object	the Number prototype

Source:

Number.js, line 10

Methods

(static) clamp(number, min, max) → {number}

Clamps a number to a range.

Parameters:

Name	Type	Description
`number`	number	The number to clamp.
`min`	number	The minimum of the range.
`max`	number	The maximum of the range.

Source:

Number.js, line 24

Returns:

The clamped number.

Type: number

(static) gcf(a, b) → {number}

Returns the GCF (Greatest Common Factor) of two numbers.

Parameters:

Name	Type	Description
`a`	number	The first number.
`b`	number	The second number.

Source:

Number.js, line 77

Returns:

The GCF

Type: number

Examples

// returns 1
Number.gcf(10, 3);

// returns 2
Number.gcf(4, 2);

(static) lcm(a, b) → {number}

Gets the LCM (Least Common Multiple) of two numbers.

Parameters:

Name	Type	Description
`a`	number	The first number.
`b`	number	The second number.

Source:

Number.js, line 98

Returns:

The LCM.

Type: number

Example

// returns 6
Number.lcm(2,3);

(static) ratio(a, b) → {string}

Turns the number into a ratio based on an argument.

Parameters:

Name	Type	Description
`a`	number	The first number.
`b`	number	The number to use as the second part of the ratio.

Source:

Number.js, line 46

Returns:

The resulting ratio.

Type: string

Examples

// returns "2:1"
let num = 2;
num.ratio(1);

// returns "2:1"
let num = 10;
num.ratio(5);

ceil() → {number}

Rounds the number up.

Source:

Number.js, line 169

Returns:

The number rounded up.

Type: number

floor() → {number}

Rounds the number down.

Source:

Number.js, line 185

Returns:

The number rounded down.

Type: number

Example

// returns 5
let num = 5.9
num.floor();

map(in_min, in_max, out_min, out_max) → {number}

Maps a number between ranges.

Parameters:

Name	Type	Description
`in_min`	number	The minimum of the input range.
`in_max`	number	The maximum of the input range.
`out_min`	number	The minimum of the output range.
`out_max`	number	The maximum of the output range.

Source:

Number.js, line 114

Returns:

The resulting number.

Type: number

modulo(number) → {number}

Returns modulo of the number

Parameters:

Name	Type	Description
`number`	number	The number to use modulo with.

Source:

Number.js, line 235

Returns:

The resulting modulo.

Type: number

Example

// returns 1
let num = 5;
num.modulo(2);

needsPromotion() → {boolean}

Whether the number is greater than the maximum allowed number

Source:

Number.js, line 257

Returns:

Whether the number is too large.

Type: boolean

Examples

// returns false
let num = 5;
num.needsPromotion();

// returns true
let num = Number.MAX_SAFE_INTEGER + 2;
num.needsPromotion();

pow(n) → {number}

Returns the number to the nth power.

Parameters:

Name	Type	Description
`n`	number	The power.

Source:

Number.js, line 157

Returns:

The number to the nth power.

Type: number

sqrt() → {number}

Finds the square root of the number.

Source:

Number.js, line 201

Returns:

The sqaure root of the number.

Type: number

Example

// returns 5
let num = 25;
num.sqrt();

toBaseN(nopt) → {string}

Returns the number in base n

Parameters:

Name	Type	Attributes	Default	Description
`n`	number	<optional>	10	The base to output the number in.

Source:

Number.js, line 129

Returns:

The number in base N.

Type: string

toOrdinal() → {number}

Returns the number in it's ordinal form.

Source:

Number.js, line 218

Returns:

The ordinal form of the number.

Type: number

Example

// returns "5th"
let num = 5;
num.toOrdinal();

toPlaceN(n) → {number}

Returns the number truncated at the nth decimal place.

Parameters:

Name	Type	Description
`n`	number	The decimal place to truncate it to.

Source:

Number.js, line 142

Returns:

The number trucated to place n

Type: number