A collection of the Number Object methods and functions.
See Also:
Notes:
Every Math method is mirrored in the Number object, both as prototype and generic.
Returns the passed parameter as a Number, or null if not a number.
Syntax:
Number.convert(arg);
Arguments:
- arg - (mixed) The argument to return as a number.
Returns:
- (number) The argument as a number.
- (null) Returns null if the number cannot be converted.
Example:
Number.convert('12') // returns 12
Number.convert('hello') // returns null
Returns a random integer between the two passed in values.
Syntax:
var random = Number.random(min, max);
Arguments:
- min - (number) The minimum value (inclusive).
- max - (number) The maximum value (inclusive).
Returns:
- (number) A random number between min and max.
Example:
Number.random(5, 20); // returns a random number between 5 and 20.
Limits this number between two bounds.
Syntax:
myNumber.limit(min, max);
Arguments:
- min - (number) The minimum possible value.
- max - (number) The maximum possible value.
Returns:
- (number) The number bounded between the given limits.
Examples:
(12).limit(2, 6.5); // returns 6.5
(-4).limit(2, 6.5); // returns 2
(4.3).limit(2, 6.5); // returns 4.3
Returns this number rounded to the specified precision.
Syntax:
myNumber.round([precision]);
Arguments:
- precision - (number, optional: defaults to 0) The number of digits after the decimal place.
Returns:
- (number) The number, rounded.
Notes:
- Argument may also be negative.
Examples:
(12.45).round() // returns 12
(12.45).round(1) // returns 12.5
(12.45).round(-1) // returns 10
Executes the function passed in the specified number of times.
Syntax:
myNumber.times(fn[, bind]);
Arguments:
- fn - (function) The function which should be executed on each iteration of the loop. This function is passed the current iteration's index.
- bind - (object, optional) The object to use as 'this' in the function. For more information see Function:bind.
Examples:
(4).times(alert); // alerts "0", then "1", then "2", then "3".
Returns this number as a float. Useful because toFloat must work on both Strings and Numbers.
Syntax:
myNumber.toFloat();
Returns:
- (number) The number as a float.
Examples:
(111).toFloat(); // returns 111
(111.1).toFloat(); // returns 111.1
Returns this number as another number with the passed in base. Useful because toInt must work on both Strings and Numbers.
Syntax:
myNumber.toInt([base]);
Arguments:
- base - (number, optional: defaults to 10) The base to use.
Returns:
- (number) A number with the base provided.
Examples:
(111).toInt(); // returns 111
(111.1).toInt(); // returns 111
(111).toInt(2); // returns 7
There are several methods available from the Math object that can be used as Number Methods.
- abs
- acos
- asin
- atan2
- ceil
- cos
- exp
- floor
- log
- max
- min
- pow
- sin
- sqrt
- tan
Examples:
(-1).abs(); // returns 1
(3).pow(4); // returns 81