1.2.0 • Published 1 year ago

random-generator.js v1.2.0

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

🎲 randjs

An npm package for randomly generating a wide range of thing like numbers, uuids, salts, etc. Also allows for randomizing data like arrays.

📖 Usage

Installation:

npm i randjs

Import:

import rg from "random-generator.js";

or

const rg = require("random-generator.js");

🔧 Functionality

Number

const number = rg.number(length);

Number within a range

const number_range = rg.numberWithinRange(max, min);
//inclusive, min value not required and it will default to 0.

Shuffle

const shiffled_array = rg.shuffle(array);

String

const random_string = rg.string(length, options);
options: {numbers?: true | false, letters?:  true | false, symbols?:  true | false, case?: "lower" | "upper" | "both"}
                    ^                       ^                       ^                                         ^
                 Default                 Default                 Default                                   Default   

UUID - WIP

32 Character UUID

const uuid = rg.uuid();

Example:

e5d520d8-d06e-4bc2-9bb9-a28e47014884

16 Character UUID

const uuid_short = rg.uuidShort();

Example:

e5d5-d0-4b-9b-a28e47

Dummy Data

Generate dummy data for testing sign up forms, etc.

Name

const name = rg.dummyData.name(options);
options: {firstname: true | false, lastname: true | false}
                      ^                       ^   
                   Default                 Default  

Email

const email = rg.dummyData.email(options);
options: {domain?: string, domainExtenstion?: string}

By default domain is gmail.com and domainExtension is empty