simplenumbers v1.1.0

simplenumbers.js

The idea is simple - reduce stress of working with numbers

npm install simplenumbers

Methods

• numberGenerator() Returns an array of generated integers. Accepts two argument, maximumNumber (endlimit), and a stride. Used for method chaining with other methods.
• getNumbers() Returns an array of generated integers.Accepts as maximumNumber. Used independently.
• fibo Returns fibonacci sequence. Accepts and object argument {start: 1, asMax: false} by defaults
• factorial Returns the factorial of an integer through numberGenerator()
• even() Returns even numbers to a defined limit through numberGenerator()
• odd() Returns odd numbers to a defined limit through numberGenerator()
• prime() Returns prime numbers to a defined limit through numberGenerator()
• calculate() Sum its arguments or return sum of values from numberGenerator(). Accepts integer or array argument of values, and a string to perform either summation or difference and returns single integer.

Relevant information

• First, initialize the libary, by creating an object of javascript SimpleNumbers().
• SimpleNumbers() accepts an object argument with three optional arguments:
• maximumNumber this is meant to be the maximum value used by numberGenerator() and getNumbers(). Defaults to 0.
• stride used by numberGenerator() to produce an array of integers in steps. Defaults to 1.
• type accepts a string value of either: prime, odd, even.

var sN = new SimpleNumbers({
  maximumNumber: , //optional integer defaults to 10
  stride: '', //optional string default to 1
  type: 'prime' //optionalstring defaults to even
});

Usage

console.log(sN.numberGenerator(5).factorial()); //120
console.log(sN.numberGenerator(10).even()); //[ 2, 4, 6, 8, 10 ]
console.log(sN.numberGenerator(15).odd()); //[ 1, 3, 5, 7, 9, 11, 13, 15 ]
console.log(sN.numberGenerator(10).prime());//[ 2, 3, 5, 7 ]
console.log(sN.numberGenerator(10).fibo());//[ 1, 1, 2, 3, 5, 8, 13, 21, 34, 55 ]
console.log(sN.numberGenerator(10).fibo({start:1, asMax: true}));//asMax=true sets 10 as maximum value in fibo sequence otherwise runs through start to 10 /** result will be [ 1, 1, 2, 3, 5, 8 ] */
console.log(sN.getNumbers(15)); //[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]
console.log(sN.getNumbers(15, true)); //starts from 1 with true specified
console.log(sN.numberGenerator().calculate(1.5,2,'sum'));//passing multiple integers returns 3.5 
console.log(sN.numberGenerator().calculate([1,2],'sum'));//passing an arrayof integers returns 3 
console.log(sN.numberGenerator().calculate(1,2,'diff'));//passing multiple integers returns -1 
console.log(sN.numberGenerator().calculate([1.8,2],'diff'));//passing an array of integers returns -0.19999999999999996

Note

Method parameters overwrite class config values

Example:

sN = new SimpleNumbers({
  type: 'prime' //optional
});
console.log(sN.numberGenerator().produceNumberType('odd')) //returns 1,3,5,7,9

Instantiating multiple objects

var sN1 = new SimpleNumbers();

var sN2 = new SimpleNumbers();

var sN3 = new SimpleNumbers({
  maximumNumber: 100 , 
  stride: '2', 
  type: 'prime' 
});

Contributing