Random Number Generator

A flexible random number generator that supports various options for generating random numbers.

Installation

npm install npmfirsttestforrandomnumbergeneration

Usage

const generateRandomNumber = require('npmfirsttestforrandomnumbergeneration');

// Generate a single random integer between 1 and 10
const random = generateRandomNumber({ min: 1, max: 10 });

// Generate a random number with 2 decimal places
const decimal = generateRandomNumber({ 
    min: 0, 
    max: 100, 
    decimals: 2 
});

// Generate multiple unique random numbers
const numbers = generateRandomNumber({ 
    min: 1, 
    max: 100, 
    count: 5 
});

// Generate random numbers excluding specific values
const excluded = generateRandomNumber({ 
    min: 1, 
    max: 10, 
    exclude: [5, 7] 
});

API

generateRandomNumber(options)

Generates random number(s) based on the provided options.

Options

• min (required): Minimum value (inclusive)
• max (required): Maximum value (inclusive)
• decimals (optional): Number of decimal places (default: 0)
• count (optional): Number of random numbers to generate (default: 1)
• exclude (optional): Array of numbers to exclude from generation

Returns

• If count is 1: Returns a single number
• If count is > 1: Returns an array of unique random numbers

Examples

// Basic usage
const basic = generateRandomNumber({ min: 1, max: 100 });
// Returns a number between 1 and 100

// With decimals
const precise = generateRandomNumber({ 
    min: 0, 
    max: 1, 
    decimals: 2 
});
// Returns a number like 0.45

// Multiple numbers
const multiple = generateRandomNumber({ 
    min: 1, 
    max: 10, 
    count: 3 
});
// Returns an array like [4, 7, 2]

// With exclusions
const safe = generateRandomNumber({ 
    min: 1, 
    max: 10, 
    exclude: [5, 7] 
});
// Returns a number between 1-10, except 5 and 7

Error Handling

The function will throw errors for invalid inputs:

• TypeError: If min or max are not provided or not valid numbers
• RangeError: If min is greater than or equal to max
• RangeError: If decimals is negative or not an integer
• RangeError: If count is less than 1 or not an integer

License

ISC