Noodles, Poodles and More!

    random-all

    1.1.0 • Public • Published

    random-all

    Generates random numbers, unique random numbers

      const random = require('random-all')
      
      let uniqueValue = random.getUnique(1,10);
      let randomInt = random.getInt(1,10);
      let randomFloat = random.getFloat(1,10);
    

    Installation

    This is a Node.js module available through the npm registry. Installation is done using the npm install command:

      npm install --save random-all

    Usage

      const random = require('random-all')
    • getUnique(min,max) : Returns a unique random number from (including) min to (including) max.
      After all unique value between min and max it will restart cycle.

      **IMPORTANT - getUnique(min,max) will reset when min and max is changed. To avoid reset use random.new() to get a new object. **

      • min : minimum value of random number. Defaults to 1.

      • max : maximum value of random number. Defaults to 100.

          const random = require('random-all')
        
          let val = random.getUnique(1,10);// unique val is between 1 and 10.
          let val = random.getUnique()// unique val is between 1 and 100.
          
          **IMPORTANT - RESET EXAMPLE**
           
            //file1.js
            let firstInterval = setInteval(1000,function(){
              //This resets(You may get same value) whenever min or max changed in secondInterval.
              let val = random.getUnique(1,10);
              console.log(val)
            });
            
            let secondInterval = setInteval(1000,function(){
              //This resets(You may get same value) because min and max is changed in firstInterval.
              let val = random.getUnique(20,30);
              console.log(val);
            });
    • getInt(min,max) : Returns a random number from (including) min to (including) max.

      • min : minimum value of random number. Defaults to 1.

      • max : maximum value of random number. Defaults to 100.

          const random = require('random-all')
        
          let val = random.getInt(1,10);// val is between 1 and 10.
          let val = random.getInt()// val is between 1 and 100.
    • getFloat(min,max) : Returns a random number from (including) min to (including) max.

      • min : minimum value of random number. Defaults to 1.

      • max : maximum value of random number. Defaults to 100.

          const random = require('random-all')
        
          let val = random.getFloat(1,10);// val is between 1 and 11.
          let val = random.getFloat(0,0);// val is between 0 and 1.
          let val = random.getFloat(1,1);// val is between 1 and 2.
          let val = random.getFloat()// val is between 1 and 101.
    • getChar(str,isUnique) : Returns a random char from string given.

      • str : string value from which a random char to be fetched. Defaults to "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789".

      • isUnique : Return unique char.

          const random = require('random-all')
        
          let val = random.getChar();// val will be a char from "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
          let val = random.getChar("abc");// val will be a or b or c.
        
          //Calling in a loop without unique
          for(let i = 0;i<4;i++){
            console.log(random.getChar("abc"));
          } //output can be a,b,a,a;
        
          //Calling in a loop with unique
          for(let i = 0;i<4;i++){
            console.log(random.getChar("abc",true));
          } //output can be b,a,c,a;
    • getBoolean(percent) : Returns a random boolean value.

      • percent : this percent of times true will be returned. Defaults to 50

          const random = require('random-all')
        
          let val = random.getBoolean(); Probabilty of true and false is 50
          let val = random.getBoolean(30); Probabilty of true and false is 30 and 70 repectively.
    • choices(population,weights) : Return a random element from the non-empty sequence according to there weight.

      IMPORTANT - use new() to avoid confusions

      • population : elements from which an element should be choosen.

      • weights : weights of each element, the sum should be equal to 100.

          const random = require('random-all')
        
          let val = random.choices(["a","b","c"],[10,40,60]);// val will be a or b or c, occurence would be based on there weights
    • setChoices(population,weights) : Used to set the elements and there weigts, later used by choices(). This is recommeded over passing parameters directly to choices()

      IMPORTANT - use new() to avoid confusions

      • population : elements from which an element should be choosen.

      • weights : weights of each element, the sum should be equal to 100.

          const random = require('random-all')
          random.setChoices(["a","b","c"],[10,40,60]);
          let val = random.choices();// val will be a or b or c, occurence would be based on there weights.

    Advanced

    • new(min,max) : Returns a new object.

      **IMPORTANT - This can be used to avoid reset problem of getUnique fumction. **

        const random = require('random-all')
      
        let obj1 = random.new();
        let obj2 = random.new();
        
        obj1.getUnique(1,10);
        obj1.getInt(1,10);
        obj1.getChar();
        
        obj2.getUnique(1,10);
        obj2.getInt(1,10);
        obj2.getChar();
        
        **IMPORTANT - RESET EXAMPLE**
         
          //file1.js
          let firstInterval = setInteval(1000,function(){
            //This resets(You may get same value) whenever min or max changed in secondInterval.
            let obj = random.new();
            let val = obj1.getUnique(1,10);
            console.log(val)
          });
          
          let secondInterval = setInteval(1000,function(){
            //This resets(You may get same value) because min and max is changed in firstInterval.
            let obj = random.new();
            let val = obj.getUnique(20,30);
            console.log(val);
          });

    Install

    npm i random-all

    DownloadsWeekly Downloads

    14

    Version

    1.1.0

    License

    MIT

    Unpacked Size

    33 kB

    Total Files

    9

    Last publish

    Collaborators

    • m4adan