Docs/Types/Number.md

   1 Type: Number {#Number}
   2 ======================
   3
   4 A collection of the Number Object methods and functions.
   5
   6 ### See Also:
   7
   8 - [MDN Number][]
   9
  10 ### Notes:
  11
  12 Every Math method is mirrored in the Number object, both as prototype and generic.
  13
  14
  15
  16 Function: Number.convert {#Number:Number:convert}
  17 ------------------------------------
  18
  19 Returns the passed parameter as a Number, or null if not a number.
  20
  21 ### Syntax:
  22
  23         Number.convert(arg);
  24
  25 ### Arguments:
  26
  27 1. arg - (*mixed*) The argument to return as a number.
  28
  29 ### Returns:
  30
  31 * (*number*) The argument as a number.
  32 * (*null*) Returns null if the number cannot be converted.
  33
  34 ### Example:
  35
  36         Number.convert('12')            // returns 12
  37         Number.convert('hello') // returns null
  38
  39
  40
  41 Function: Number.random {#Number:Number-random}
  42 ----------------------------------------
  43
  44 Returns a random integer between the two passed in values.
  45
  46 ### Syntax:
  47
  48         var random = Number.random(min, max);
  49
  50 ### Arguments:
  51
  52 1. min - (*number*) The minimum value (inclusive).
  53 2. max - (*number*) The maximum value (inclusive).
  54
  55 ### Returns:
  56
  57 * (*number*) A random number between min and max.
  58
  59 ### Example:
  60
  61         Number.random(5, 20); // returns a random number between 5 and 20.
  62
  63
  64
  65 Number method: limit {#Number:limit}
  66 -----------------------------
  67
  68 Limits this number between two bounds.
  69
  70 ### Syntax:
  71
  72         myNumber.limit(min, max);
  73
  74 ### Arguments:
  75
  76 1. min - (*number*) The minimum possible value.
  77 2. max - (*number*) The maximum possible value.
  78
  79 ### Returns:
  80
  81 * (*number*) The number bounded between the given limits.
  82
  83 ### Examples:
  84
  85         (12).limit(2, 6.5);  // returns 6.5
  86         (-4).limit(2, 6.5);  // returns 2
  87         (4.3).limit(2, 6.5); // returns 4.3
  88
  89
  90
  91 Number method: round {#Number:round}
  92 -----------------------------
  93
  94 Returns this number rounded to the specified precision.
  95
  96 ### Syntax:
  97
  98         myNumber.round([precision]);
  99
 100 ### Arguments:
 101
 102 1. precision - (*number*, optional: defaults to 0) The number of digits after the decimal place.
 103
 104 ### Returns:
 105
 106 * (number) The number, rounded.
 107
 108 ### Notes:
 109
 110 - Argument may also be negative.
 111
 112 ### Examples:
 113
 114         (12.45).round()   // returns 12
 115         (12.45).round(1)  // returns 12.5
 116         (12.45).round(-1) // returns 10
 117
 118
 119
 120 Number method: times {#Number:times}
 121 -----------------------------
 122
 123 Executes the function passed in the specified number of times.
 124
 125 ### Syntax:
 126
 127         myNumber.times(fn[, bind]);
 128
 129 ### Arguments:
 130
 131 1. fn   - (*function*) The function which should be executed on each iteration of the loop. This function is passed the current iteration's index.
 132 2. bind - (*object*, optional) The object to use as 'this' in the function. For more information see [Function:bind][].
 133
 134 ### Examples:
 135
 136         (4).times(alert); // alerts "0", then "1", then "2", then "3".
 137
 138
 139
 140 Number method: toFloat {#Number:toFloat}
 141 ---------------------------------
 142
 143 Returns this number as a float. Useful because toFloat must work on both Strings and Numbers.
 144
 145 ### Syntax:
 146
 147         myNumber.toFloat();
 148
 149 ### Returns:
 150
 151 * (*number*) The number as a float.
 152
 153 ### Examples:
 154
 155         (111).toFloat(); // returns 111
 156         (111.1).toFloat(); // returns 111.1
 157
 158
 159
 160 Number method: toInt {#Number:toInt}
 161 -----------------------------
 162
 163 Returns this number as another number with the passed in base. Useful because toInt must work on both Strings and Numbers.
 164
 165 ### Syntax:
 166
 167         myNumber.toInt([base]);
 168
 169 ### Arguments:
 170
 171 1. base - (*number*, optional: defaults to 10) The base to use.
 172
 173 ### Returns:
 174
 175 * (*number*) A number with the base provided.
 176
 177 ### Examples:
 178
 179         (111).toInt(); // returns 111
 180         (111.1).toInt(); // returns 111
 181         (111).toInt(2); // returns 7
 182
 183
 184 Math Methods {#Number-Math}
 185 --------------------
 186
 187 There are several methods available from the Math object that can be used as Number Methods.
 188
 189 - abs
 190 - acos
 191 - asin
 192 - atan2
 193 - ceil
 194 - cos
 195 - exp
 196 - floor
 197 - log
 198 - max
 199 - min
 200 - pow
 201 - sin
 202 - sqrt
 203 - tan
 204
 205 ### Examples:
 206
 207         (-1).abs(); // returns 1
 208         (3).pow(4); // returns 81
 209
 210
 211 [Function:bind]: /core/Types/Function/#Function:bind
 212 [MDN Number]: https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Number