Neil Patrick's Mansion

    totally-random

    1.2.3 • Public • Published

    Table of Contents

    Installation

    npm i totally-random

    Importing

    const TotallyRandom = require("totally-random");
    const random = new TotallyRandom();

    All numbers are inclusive. If you use an API or another technique to get random numbers (i.e. RANDOM.org), you may supply your own function in the constructor. It must return a floating point number between 0 and 1, not including 1.

    const random = new TotallyRandom(randomFunction);

    Array

    .array(arr, [count = 1], [unique = false])

    Returns a random element from an array or an array of random array elements

    Parameter Type Description
    arr Array The array of elements to select from
    count (Optional) Number The amount of elements to include in the returned array. Default = 1
    unique (Optional) Boolean Determines whether output array contains duplicate elements or unique elements. Default = false
    random.array(["Paul", "Chani", "Gurney"]);
    // Chani
     
    random.array(["Paul", "Chani", "Gurney"], 5);
    // ["Gurney", "Paul", "Gurney", "Chani", "Chani"]

    Between

    .between(num1, num2, [count = 1])

    Return a number, or array of numbers, within a given range.

    Parameter Type Description
    num1 Number The beginning number of the range
    num2 Number The ending number of the range
    count (Optional) Number The amount of numbers to include in the returned array. Default = 1
    random.between(25, 50);
    // 34
     
    random.between(100, 200, 3);
    // [192, 125, 167]

    Boolean

    .boolean([count = 1])

    Return a boolean or array or booleans

    Parameter Type Description
    count (Optional) Number The amount of booleans to include in the returned array. Default = 1
    random.boolean();
    // false
     
    random.boolean(5);
    // [true, false, false, true, false]

    Chance

    .chance(arr, [count = 1])

    Returns a random user given data type based on altered chance

    Parameter Type Description
    arr Array The array of arrays of elements containing any data type and percent chance of being selected
    count (Optional) Number Return a data type chosen by an altered chance
    random.chance([
      ["Hoyt", 15],
      ["Kassad", 30],
      ["Silenus", 45],
      ["Weintraub", 10],
    ]);
    // Silenus
     
    random.chance(
      [
        ["Hoyt", 15],
        ["Kassad", 30],
        ["Silenus", 45],
        ["Weintraub", 10],
      ],
      5
    );
    // ["Weintraub", "Silenus", "Hoyt", "Selinus", "Weintraub"]

    Color

    .color([option = "hex"], [count = 1]) | .colour([option = "hex"], [count = 1])

    Returns a random color, or array of colors, in the form of a Hexcode, RGB, RGBA, HSL, or HSLA value.

    Parameter Type Description
    option (Optional) String The type of color value you would like returned. Default = "hex". Valid options: "hex", "rgb", "rgba", "hsl", "hsla"
    count (Optional) Number TThe amount of color strings to include in the returned array. Default = 1
    random.color();
    // #3bf93d
     
    random.color(5);
    // [ '#117949', '#878dbc', '#f11955', '#1e729e', '#aa885f' ]
     
    random.color("rgb", 3);
    // [ 'rgb(0, 18, 127)', 'rgb(236, 237, 191)', 'rgb(157, 199, 22)' ]
     
    random.color("rgba");
    // rgb(227, 30, 44, 0.7)
     
    random.color("hsl");
    // hsl(326, 87%, 43%)
     
    random.color("hsla");
    // hsla(328, 72%, 44%, 0.8)

    Float Between

    .floatBetween(num1, num2, [count = 1])

    Return a floating number, or array of floating numbers, within a given range.

    Parameter Type Description
    num1 Number The beginning number of the range
    num2 Number The ending number of the range
    count (Optional) Number The amount of numbers to include in the returned array. Default = 1
    random.floatBetween(25, 50);
    // 46.868391548018025
     
    random.floatBetween(100, 200, 3);
    //  [
    //    110.7345996614564,
    //    144.02195688891862,
    //    166.7222947358983
    //  ]

    Float Percent

    .floatPercent([count = 1])

    Returns a random floating number between 1-100, or an array of random floating numbers between 1-100.

    Parameter Type Description
    count (Optional) Number The amount of elements to include in the returned array. Default = 1
    random.floatPercent();
    // 31.20330415243886
     
    random.floatPercent(5);
    //  [
    //    31.19643983316984,
    //    59.981506602103664,
    //    3.179024087615012
    //  ]

    Float To

    .floatTo(num)

    Returns a random floating number between 1 (or -1) and the number you specify, or an array of random floating numbers between 1 (or -1) and the number you specify.

    Parameter Type Description
    num Number The maximum number to select from
    count (Optional) Number The amount of numbers to include in the returned array. Default = 1
    random.floatTo(10);
    // 6.5380310716535646
     
    random.floatTo(-99, 3);
    //  [
    //    -59.29789405751423,
    //    -25.36979445038661,
    //    -19.477123607499205
    //  ]

    Percent

    .percent([count = 1])

    Returns a random number between 1-100, or an array of random numbers between 1-100.

    Parameter Type Description
    count (Optional) Number The amount of elements to include in the returned array. Default = 1
    random.percent();
    // 27
     
    random.percent(5);
    // [37, 88, 24, 90, 11]

    Shuffle

    .shuffle(arr)

    Return a shuffled version of a given array using the Fisher-Yates Algorithm

    Parameter Type Description
    arr Array The array of elements to shuffle
    random.shuffle([1, 2, 3, 4, 5]);
    // [3, 5, 2, 1, 4]

    String

    .string([option = "alphanumeric"], [length = between(4, 24)])

    Returns a random string.

    Parameter Type Description
    option (Optional) String The type of string you would like to return. Default = "alphanumeric". Valid options: "alphanumeric", "alpha", "numeric"
    length (Optional) Number The length you would like the string to be. Default = between(4, 24)
    random.string();
    // hX4XHE2M6eyE9XM1fj3
     
    random.string(5);
    // Us8dP
     
    random.string("alpha");
    // DCjWSnSOuSjK
     
    random.string("numeric");
    // 9386263812837196384
     
    random.string("alpha", 8);
    // ajmRmsEC

    To

    .to(num)

    Returns a random number between 1 (or -1) and the number you specify, or an array of random numbers between 1 (or -1) and the number you specify.

    Parameter Type Description
    num Number The maximum number to select from
    count (Optional) Number The amount of numbers to include in the returned array. Default = 1
    random.to(10);
    // 7
     
    random.to(-99, 3);
    // [-64, -1, -27]

    Contributing

    Pull requests are welcome if they are related to practical random generation. For major changes, please open an issue first to discuss what you would like to change.


    License

    This project is licensed under the MIT License.

    Install

    npm i totally-random

    DownloadsWeekly Downloads

    7

    Version

    1.2.3

    License

    MIT

    Unpacked Size

    22 kB

    Total Files

    7

    Last publish

    Collaborators

    • 2spacemilk