eden-number

#Number

DESCRIPTION

General

Installation

npm install eden-number

Usage

var number = require('eden-number');

Methods

• abs

• acos

• asin

• atan

• between

• ceil

• cos

• cubed

• divided

• equals

• exp

• floor

• greaterThan

• greaterThanEquals

• isInfinite

• isFloat

• isInteger

• isNaN

• lessThan

• lessThanEquals

• log

• minus

• mod

• plus

• pow

• round

• sin

• squared

• sqrt

• tan

• times

• toString

---

abs

 number abs(8);

Returns the absolute value

Parameters

1. 8 - number (positive | negative | float | double)

Returns

number

Example

Code

number().abs(8);
number().abs(-8);
number().abs(8.1);
number().abs(-8.13);

Outputs

8
8
8.1
8.13

---

acos

 number acos(0.3);

Returns the arccosine of x, in radians

Parameters

1. 0.3 - number (float | negative | double | positive)

Returns

number

Example

Code

number().acos(0.3);
number().acos(0.3);
number().acos(-0.3);
number().acos(0.34);
number().acos(1.3);
number().acos(3);

Outputs

Math.acos(0.3)
1.2661036727794992
1.8754889808102941
1.2238794292677349
'NaN'
'NaN'

---

asin

 number asin(0.3);

Returns the arcsine of x, in radians

Parameters

1. 0.3 - number (float | double)

Returns

number

Example

Code

number().asin(0.3);
number().asin(0.3);
number().asin(-0.3);
number().asin(0.35);

Outputs

Math.asin(0.3)
0.3046926540153975
-0.30469265401539752
0.35757110364551026

---

atan

 number atan(8723321.4);

Returns the arctangent of x as a numeric value between -PI/2 and PI/2 radians

Parameters

1. 8723321.4 - number (positive | negative | float | double)

Returns

number

Example

Code

number().atan(8723321.4);
number().atan(8723321.4);
number().atan(-8723321.4);
number().atan(8);

Outputs

Math.atan(8723321.4)
1.5707962121596615
-1.5707962121596615
1.446441332248135

---

between

 bool true if 'value' is within 'start' and 'finish' between(8, 2, 12);

Test if value is between start and finish.

Parameters

1. 8 - number (positive | negative | float | double)

2. 2 - start lower bound - number (positive | negative | float | double)

3. 12 - finish upper bound - number (positive | negative | float | double)

Returns

bool true if 'value' is is within 'start' and 'finish'

Example

Code

number().between(8, 2, 12);
number().between(8, 9, 20);
number().between(9, 9, 20);
number().between(0, -1, 1);
number().between(1.7, 1.5, 1.9);

Outputs

true
false
false
true
true

---

ceil

 number ceil(4.9);

Returns x, rounded upwards to the nearest integer

Parameters

1. 4.9 - number (positive | negative | float | double)

Returns

number

Example

Code

number().ceil(4.9);
number().ceil(4.9);
number().ceil(-4.9);
number().ceil(4.1);
number().ceil(4.0);

Outputs

5
-4
5
4

---

cos

 number cos(3);

Returns the cosine of x (x is in radians)

Parameters

1. 3 - number (positive | negative | float | double)

Returns

number

Example

Code

number().cos(3);
number().cos(3);
number().cos(-3);
number().cos(3.5);
number().cos(-3.5);

Outputs

Math.cos(3)
-0.9899924966004454
-0.9899924966004454
-0.9364566872907963
-0.9364566872907963

---

cubed

 this cubed(3);

Cubes data

Parameters

1. 3 - number (positive | negative | float | double)

Returns

this

Example

Code

number().cubed(3);
number().cubed(-3);
number().cubed(3.5);
number().cubed(-3.5);

Outputs

27
-27
42.875
-42.875

---

divided

 number divided(6, 3);

Divides data by value

Parameters

1. 6 - divident - number (positive | negative | float | double)

2. 3 - divisor - number (positive | negative | float | double)

Returns

number

Example

Code

number().divided(6, 3);
number().divided(-6, 3);
number().divided(6, -3);
number().divided(-6, -3);
number().divided(6.5, 3);
number().divided(6, 3.5);

Outputs

2
-2
-2
2
2.1666666666666665
1.7142857142857142

---

equals

 bool equals(8, '8', true,);

Returns true if given value equals string

Parameters

1. 8 - number (positive | negative | float | double)

2. '8' - mixed

3. true - bool strict mode

Returns

bool

Example

Code

number().equals(8, '8');
number().equals(8, '8', true);
number().equals(8, 8);
number().equals(8, 9);
number().equals(8, 8.0);
number().equals(8, '8', false);
number().equals(8, -8);

Outputs

true
false
true
false
true
true
false

---

exp

 number exp(1);

Returns the value of Ex

Parameters

1. 1 - number (positive | negative | float | double)

Returns

number

Example

Code

number().exp(1);
number().exp(1.5);
number().exp(-1);

Outputs

2.718281828459045
4.4816890703380645
0.36787944117144233

---

floor

 number floor(8.89432);

Returns x, rounded downwards to the nearest integer

Parameters

1. 8.89432 - number (positive | negative | float | double)

Returns

number

Example

Code

number().floor(8.89432);
number().floor(-8.89432);

Outputs

8
-9

---

greaterThan

 bool greaterThan(8, 8, true);

Returns true if data is greater than value

Parameters

1. 8 - number (positive | negative | float | double)

2. 8 - number (positive | negative | float | double)

3. true - bool - also equals

Returns

bool

Example

Code

number().greaterThan(8, 8, true);
number().greaterThan(8, 8, false);
number().greaterThan(9, 8);
number().greaterThan(8, 9);
number().greaterThan(9.1, 9);

Outputs

true
false
true
false
true

---

greaterThanEquals

 bool greaterThanEquals(8, 8);

Returns true if data is greater or equal to value

Parameters

1. 8 - number (positive | negative | float | double)

2. 8 - number (positive | negative | float | double)

Returns

bool

Example

Code

number().greaterThanEquals(8, 8);
number().greaterThanEquals(8, 9);
number().greaterThanEquals(9, 8);
number().greaterThanEquals(9.2, 9,1);
number().greaterThanEquals(-9, -8);

Outputs

true
false
true
true
false

---

isInfinite

 bool isInfinite(Infinity);

Returns True if data is infinite

Parameters

1. Infinity - without any limit

Returns

bool

Example

Code

number().isInfinite(Infinity);
number().isInfinite(8);

Outputs

true
false

---

isFloat

 bool isFloat(8.45);

Returns True if data is a float

Parameters

1. 8.45 - number ( float | double)

Returns

bool

Example

Code

number().isFloat(8.45);
number().isFloat(8);
number().isFloat(-8);
number().isFloat(-8.5);

Outputs

true
false
false
true

---

isInteger

 bool isInteger(8);

Returns True if data is an integer

Parameters

1. 8 - number (positive | negative)

Returns

bool

Example

Code

number().isInteger(8);
number().isInteger(8.45);
number().isInteger(-8);

Outputs

true
false
true

---

isNaN

 bool isNaN(8);

Returns True if data is NaN

Parameters

1. 8 - number (positive | negative | float | double)

Returns

bool

Example

Code

number().isNaN('Yes');
number().isNaN(8);
number().isNaN('a');

Outputs

true
false
true

---

lessThan

 bool lessThan(8, 8, true);

Returns true if data is less than value

Parameters

1. 8 - number (positive | negative | float | double)

2. 8 - number (positive | negative | float | double)

3. true - bool - also equals

Returns

bool

Example

Code

number().lessThan(8, 8, true);
number().lessThan(8, 8, false);
number().lessThan(8, 9, true);
number().lessThan(8, 9, false);
number().lessThan(9, 8, true);
number().lessThan(9, 8, false);

number().lessThan(8, 8);
number().lessThan(8, 9);
number().lessThan(9, 8);
number().lessThan(-9, -8);

Outputs

true
false
true
true
false
false

false
true
false
true

---

lessThanEquals

 bool lessThanEquals(8, 8);

Returns true if data is less or equal to value

Parameters

1. 8 - number (positive | negative | float | double)

2. 8 - number (positive | negative | float | double)

Returns

bool

Example

Code

number().lessThanEquals(8, 8);
number().lessThanEquals(8, 7);
number().lessThanEquals(7, 8);

Outputs

true
false
true

---

log

 number log(2);

Returns the natural logarithm (base E) of x

Parameters

1. 2 - number (positive | negative | float | double)

Returns

number

Example

Code

number().log(2);
number().log(-2);
number().log(1);
number().log(2.5);

Outputs

0.6931471805599453
'NaN'
0
0.9162907318741551

---

minus

 number minus(12, 4);

Subtracts data by value

Parameters

1. 12 - minuend - number (positive | negative | float | double)

2. 4 - subtrahend - number (positive | negative | float | double)

Returns

number

Example

Code

number().minus(12, 4);
number().minus(-12, 4);
number().minus(12, -4);
number().minus(-12, -4);
number().minus(12.5, 4.3);

Outputs

8
-16
16
-8
8.2

---

mod

 number mod(8, 2);

Mods data by value

Parameters

1. 8 - dividend - number (positive | negative | float | double)

2. 2 - divisor - number (positive | negative | float | double)

Returns

number

Example

Code

number().mod(8, 3);
number().mod(-8, 3);
number().mod(8, -3);
number().mod(-8, -3);
number().mod(8.5, 3.5);

Outputs

2
-2
2
-2
1.5

---

plus

 number plus(8, 4);

Adds data by value

Parameters

1. 8 - addend - number (positive | negative | float | double)

2. 4 - addend - number (positive | negative | float | double)

Returns

number

Example

Code

number().plus(8, 4);
number().plus(-8, 4);
number().plus(8, -4);
number().plus(-8, -4);
number().plus(8.5, 4.5);

Outputs

12
-4
4
-12
13

---

pow

 number pow(2, 4);

Returns the value of x to the power of y

Parameters

1. 2 - base - number (positive | negative | float | double)

2. 4 - exponent - number (positive | negative | float | double)

Returns

number

Example

Code

number().pow(2, 4);
number().pow(2, 3);
number().pow(-2, 4);
number().pow(-2, 3);
number().pow(2.5, 3);
number().pow(2, 3.5);
number().pow(2, -3.5);

Outputs

16
8
16
-8
15.625
11.313708498984761
0.08838834764831845

---

round

 number round(8.5);

Rounds x to the nearest integer

Parameters

1. 8.5 - number (positive | negative | float | double)

Returns

number

Example

Code

number().round(8.5);
number().round(8.4);
number().round(-8.5);
number().round(8.6);

Outputs

9
8
-8
-9

---

sin

 number sin(3);

Returns the sine of x (x is in radians)

Parameters

1. 3 - number (positive | negative | float | double)

Returns

number

Example

Code

number().sin(3);
number().sin(3);
number().sin(-3);
number().sin(3.5);
number().sin(-3.5);

Outputs

Math.sin(3)
0.1411200080598672
-0.1411200080598672
-0.35078322768961984
0.35078322768961984

---

squared

 number squared(9);

Squares value

Parameters

1. 9 - base - number (positive | negative | float | double)

Returns

number

Example

Code

number().squared(9);
number().squared(-9);
number().squared(9.5);
number().squared(-9.5);

Outputs

81
81
90.25
90.25

---

sqrt

 number sqrt(9);

Returns the square root of x

Parameters

1. 9 - square - number (positive | float | double)

Returns

number

Example

Code

number().sqrt(9);
number().sqrt(81);
number().sqrt(9.5);

Outputs

3
9
3.082207001484488

---

tan

 number tan(90);

Returns the tangent of an angle

Parameters

1. 90 - number (positive | negative | float | double)

Returns

number

Example

Code

number().tan(90);
number().tan(90);
number().tan(-90);
number().tan(90.5);
number().tan(-90.5);

Outputs

Math.tan(90)
-1.995200412208242
1.995200412208242
-0.6932582489897723
0.6932582489897723

---

times

 number times(8, 4);

Multiplies data by value

Parameters

1. 8 - number (positive | negative | float | double)

2. 4 - number (positive | negative | float | double)

Returns

number

Example

Code

number().times(8, 4);
number().times(-8, 4);
number().times(8, -4);
number().times(-8, -4);
number().times(8.5, 4.5);

Outputs

32
-32
-32
32
38.25

---

toString

 string toString(15);

Returns the string value of a Number object

Parameters

1. 15 - number (positive | negative | float | double)

Returns

string

Example

Code

number().toString(15);
number().toString(-15);
number().toString(15.5);
number().toString(-15.5);

Outputs

'15'
'-15'
'15.5'
'-15.5'