@rockyli/random v1.1.0

node-random

A lightweight Javascript library to generate random values with simple API.

Installation

To install the random generator, use npm:

npm install --save @rockyli/random

Usage

const random = require('@rockyli/random');

random.integer(min = 0, max = 100); // generate integer from 0 to 100
random.number(min = 0, max = 100); // generate number from 0.0 to 100.0
random.boolean(); // true or false
random.bytes(len = 16); // generate cryptographically strong pseudo-random data
random.string(len = 16, type = 'alphanumeric', capitalization = 'lowercase'); // generate random string
random.uuid(); // generate random uuid version 4 string
random.date(); // generate random date between 1970-01-01 00:00:00 and 2038-01-19 03:14:07
random.date(new Date(Date.UTC(2000, 0, 1, 0, 0, 0)), new Date(Date.UTC(2019, 2, 14, 0, 0, 0))); // generate random date between 
random.element(array = []); // return random element in provided array

API

• integer(min, max)

  • min - the minimum value of random integer. (default: 0) OPTIONAL
  • max - the maxium value of random integer. (default: 100) OPTIONAL

• number(min, max)

  • min - the minimum value of random integer. (default: 0.0) OPTIONAL
  • max - the maxium value of random integer. (default: 100.0) OPTIONAL

• boolean()

• string(len, type, capitalization)

  • len - the length of the random string. (default: 16) OPTIONAL
  • type - define the character set for the string. (default: alphanumeric) OPTIONAL
    • alphanumeric - 0-9 a-z A-Z
    • alphabetic - a-z A-Z
    • numeric - 0-9
    • hex - 0-9 a-f
    • custom - any given characters
  • capitalization - define whether the output should be lowercase or uppercase only. (default: lowercase) OPTIONAL
    • lowercase
    • uppercase
    • null

• uuid()

• date(min, max)

  • min - the earliest date of random date. (default: new Date(Date.UTC(1970, 0, 1, 0, 0, 0))) OPTIONAL
  • max - the latest date of random date. (default: new Date(Date.UTC(2038, 0, 19, 3, 14, 7))) OPTIONAL

• element(array)

  • array - array provided for random element. (default: []) OPTIONAL

Tests

npm install
npm run test

LICENSE

node-random is licensed under the MIT license.