number

number

Source:
the JS native Number class

Methods

between(n, fromopt, toopt) → {*|boolean}

Source:
checks if a number is between a range
Example

eg. usage

console.log((5).between(1, 10)); // true

console.log((5).between(1, 4)); // false
Parameters:
Name Type Attributes Default Description
n number the number
from number <optional>
 Number.MIN_VALUE the from number
to number <optional>
 Number.MAX_VALUE the to number
Returns:
Type
* | boolean

degreeDiff(a1, a2) → {Number}

Source:
Returns the minimum distance from angle `a1` to `a2` (both in degrees). The result is kept between 0 and 359.
Parameters:
Name Type Description
a1 Number The initial angle in degrees.
a2 Number The final angle in degrees.
Returns:
The angle distance value.
Type
Number

degreeDir(a1, a2) → {Integer}

Source:
Returns the direction that represents the minimum distance from angle `a1` to `a2` (in degrees). The result is `-1`, `1`, or `0` if equal.
Parameters:
Name Type Description
a1 Number The initial angle in degrees.
a2 Number The final angle in degrees.
Returns:
A direction -1, 1 or 0.
Type
Integer

degreeWrap(angle) → {Number}

Source:
wraps an angle value (in degrees) between 0 and 359.
Parameters:
Name Type Description
angle Number The angle in degrees.
Returns:
The wrapped value.
Type
Number

floor(n, precisionopt) → {number}

Source:
floors a value
Example

eg. usage

console.log((5.076).floor()); // 4

console.log((5.076).floor(2)); // 5.07

console.log((5070).floor(-2)); // 5000
Parameters:
Name Type Attributes Default Description
n number the number
precision number <optional>
 0 the precision number
Returns:
Type
number

fromRoman(s) → {number}

Source:
converts a Romans Number String in a Decimal Number
Example

eg. usage

console.log(Number.fromRoman('MCMLXXX')); // 1980
Parameters:
Name Type Description
s string the roman number string
Returns:
Type
number

isNumber() → {boolean}

Source:
check if something is a number
Example

eg. usage

var n = 1;

console.log(Number.isNumber(n)); // true

console.log(Number.isNumber(2)); // true

console.log(Number.isNumber('')); // false

console.log(Number.isNumber(null)); // false
Returns:
Type
boolean

parse(n) → {number|null}

Source:
parse a number value, returns null if parsing failes
Example

eg. usage

console.log(Number.parse("1")); // 1

console.log(Number.parse("1,25")); // 1.25

console.log(Number.parse({})); // null
Parameters:
Name Type Description
n * the value to be parsed
Returns:
Type
number | null

random(loweropt, upperopt, floatingopt) → {number}

Source:
randomizes a number
Example

eg. usage

console.log(Number.random(1, 5)); // a number between 1 and 5

console.log(Number.random(1, 5, true)); // a number between 1.0 and 5.0

console.log(Number.random()); // a number between Number.MIN_VALUE and Number.MAX_VALUE
Parameters:
Name Type Attributes Default Description
lower number <optional>
 Number.MIN_VALUE the lower number
upper number <optional>
 Number.MAX_VALUE the upper number
floating boolean <optional>
 false ask to return a floating number value
Returns:
Type
number

range(startopt, end, reverse, stepopt) → {array}

Source:
Creates an array of numbers (positive and/or negative) progressing from start up to, but not including, end. A step of -1 is used if a negative start is specified without an end or step. If end is not specified, it's set to start with start then set to 0.
Examples

eg. usage

console.log(Array.range(4));
// [0, 1, 2, 3]

console.log(Array.range(-4));
// [0, -1, -2, -3]

console.log(Array.range(1, 5));
// [1, 2, 3, 4]

console.log(Array.range(0, 20, 5));
// [0, 5, 10, 15]

console.log(Array.range(0, -4, -1));
// [0, -1, -2, -3]

console.log(Array.range(1, 4, 0));
// [1, 1, 1]

console.log(Array.range(0);
// []

eg. usage (reverse)

console.log(Array.rangeRight(4));
// [3, 2, 1, 0]

console.log(Array.rangeRight(-4));
// [-3, -2, -1, 0]

console.log(Array.rangeRight(1, 5));
// [4, 3, 2, 1]

console.log(Array.rangeRight(0, 20, 5));
// [15, 10, 5, 0]

console.log(Array.rangeRight(0, -4, -1));
// [-3, -2, -1, 0]

console.log(Array.rangeRight(1, 4, 0));
// [1, 1, 1]

console.log(Array.rangeRight(0));
// []
Parameters:
Name Type Attributes Default Description
start number <optional>
 0 the start of the range
end number the end of the range
reverse boolean true, if ou want a reverse range
step number <optional>
 1 the value to increment or decrement by
Returns:
Type
array

round(n, precisionopt) → {number}

Source:
crops a value between specified bounds
Example

eg. usage

console.log(Number.crop(5, 1, 10)); // 5

console.log(Number.crop(5, 2, 4)); // 4

console.log(Number.crop(5, 2)); // 5

console.log(Number.crop(5, 6)); // 6

console.log(Number.crop('5')); // '5'

console.log((5).crop(1, 10)); // 5

console.log((5).crop(2, 4)); // 4

console.log((5).crop(2)); // 5

console.log((5).crop(6)); // 6
Parameters:
Name Type Attributes Default Description
n number the number
precision number <optional>
 0 the precision number
Returns:
Type
number

round(n, precisionopt) → {number}

Source:
rounds a value
Example

eg. usage

console.log((5.007).round()); // 5

console.log((5.007).round(2)); // 5.01

console.log((5070).round(-2)); // 5100
Parameters:
Name Type Attributes Default Description
n number the number
precision number <optional>
 0 the precision number
Returns:
Type
number

times(n, iteratee, reverseopt)

Source:
repeats a function n times
Examples

eg. usage

(5).times(function(i) {
  console.log(i);
});

// logs 1, 2, 3, 4, 5

or

(5).times(function(i) {
  console.log(i);
}, true);

// logs 5, 4, 3, 2, 1
Parameters:
Name Type Attributes Default Description
n number the number of times
iteratee function the iteratee function to invoke
the iteratee will be invoked passing the index as i
so the iteratee has to be something like this
function(i) {}
Properties
Name Type Description
i number the index
reverse boolean <optional>
 false true if you want to do a times reverse cycle

toAbsolute(n) → {number}

Source:
absolutes a number
Example

eg. usage

console.log((1).toAbsolute()); // 1

console.log((1.56).toAbsolute()); // 1.56

console.log((-1.56).toAbsolute()); // 1.56
Parameters:
Name Type Description
n number the number
Returns:
Type
number

toCurrency(n, optionsopt) → {string}

Source:
formats a number to a currency string
Example

eg. usage

console.log((1).toCurrency()); // 1,00 €

console.log((1).toCurrency({decimals: 3}); // 1,000 €

console.log((123456.789).toCurrency({decimals: 2}); // 123.456,79 €

console.log((123456.789).toCurrency({sections: 4, decimals: 3}); // 12.3456,789 €

console.log((123456.789).toCurrency({sections: 4, sectionsDelimiter: ',', decimals: 3, decimalsDelimiter: '.'}); // 12,3456.789 €
Parameters:
Name Type Attributes Default Description
n number the number
options object <optional>
 false options to be used as parameters for conversion
Properties
Name Type Attributes Default Description
sections number <optional>
 3 sections - section to divide the integer part of number in
sectionsDelimiter string <optional>
 '.' sectionsDelimiter - delimiter used to separe integer sections
decimals number <optional>
 2 decimals - desired number of decimals
decimalsDelimiter string <optional>
 ',' decimalsDelimiter - delimiter used to separe decimals from integer part of number
symbol string <optional>
 '' symbol - currency symbol or measure unit to use (eg. '€')
symbolAppend boolean <optional>
 true symbolAppend - if true the symbol will be appended to the number
symbolNumberSeparator string <optional>
 '&nbsp;' symbolNumberSeparator - the separator that will be used to divide symbol from the number
Returns:
Type
string

toFileSize(n, precision) → {*}

Source:
converts a number of bytes in a human readable file size string
Example

eg. usage

console.log((1024).toFileSize()); // 1kb
Parameters:
Name Type Description
n number the number
precision number the precision number
Returns:
Type
*

toRoman(n) → {string}

Source:
converts a number in a Roman Number String
Example

eg. usage

console.log((1980).toRoman()); // 'MCMLXXX'
Parameters:
Name Type Description
n number the number
Returns:
Type
string

toSymbolString(n, optionsopt) → {string}

Source:
converts a number to a integer/float string with symbol (currency, measure unit) support
Example

eg. usage

console.log((1).toSymbolString()); // 1,00

console.log((1).toSymbolString({decimals: 3}); // 1,000

console.log((123456.789).toSymbolString({decimals: 2}); // 123,456.79
console.log((123456.789).toSymbolString({sections: 4, decimals: 2}); // 12,3456.79

console.log((123456.789).toSymbolString({symbol: 'kWh'}); // 12.3456,79 kWh
console.log((123456.789).toSymbolString({symbol: '&euro;', symbolNumberSeparator: ''}); // 123.456,79&euro;

console.log((123456.789).toSymbolString({sectionsDelimiter: '.', decimalsDelimiter: ','}); // 123.456,789
Parameters:
Name Type Attributes Default Description
n number the number
options object <optional>
 false options to be used as parameters for conversion
Properties
Name Type Attributes Default Description
sections number <optional>
 3 sections - section to divide the integer part of number in
sectionsDelimiter string <optional>
 ',' sectionsDelimiter - delimiter used to separe integer sections
decimals number <optional>
 2 decimals - desired number of decimals
decimalsDelimiter string <optional>
 '.' decimalsDelimiter - delimiter used to separe decimals from integer part of number
symbol string <optional>
 '' symbol - currency symbol or measure unit to use (eg. '€')
symbolAppend boolean <optional>
 true symbolAppend - if true the symbol will be appended to the number
symbolNumberSeparator string <optional>
 '&nbsp;' symbolNumberSeparator - the separator that will be used to divide symbol from the number
Returns:
Type
string