es-toolkit/docs/reference/math/random.md

# random

Generate a random number within the given range. The number can be an integer or a decimal.

If only one argument is provided, a number between `0` and the given number is returned.

## Signature

```typescript
function random(maximum: number): number;
function random(minimum: number, maximum: number): number;
```

### Parameters

- `minimum` (`number`): The lower bound for the random number (inclusive).
- `maximum` (`number`): The upper bound for the random number (exclusive).

### Returns

- (`number`): A random number within the specified range. The number can be an integer or a decimal.

## Examples

```typescript
const result1 = random(0, 5); // Returns a random number between 0 and 5.
const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown
const result3 = random(5, 5); // If the minimum is equal to the maximum, an error is thrown.
```
feat(random): Adds a function that generates a random floating-point number between the minimum and maximum. (#53) * feat(random): Add generating a random floating-point number between min and max * test(random) : Add tests for random function * feat : Add random function to math module * test : Add benchmark for random function * refactor : Change the words min, max to minimum, maximum * docs(random) : Add docs about random function * docs(random): Add docs about random function * docs(random): Fix documentation typos * docs(random): Fix documentation typos * docs(random): Fix spacing * docs(random): Fix spacing * docs(random): Update interface heading * docs(random): Update interface heading * fix(random): Validate input parameters and throw error for invalid ranges * test(random) : Update tests for new input validation logic * docs(random) : Update documentation for new input validation logic 2024-06-15 09:20:54 +03:00			`# random`

docs(random, randomInt): Add docs for randomInt, and polish docs for random 2024-06-15 10:00:20 +03:00			`Generate a random number within the given range. The number can be an integer or a decimal.`
feat(random): Adds a function that generates a random floating-point number between the minimum and maximum. (#53) * feat(random): Add generating a random floating-point number between min and max * test(random) : Add tests for random function * feat : Add random function to math module * test : Add benchmark for random function * refactor : Change the words min, max to minimum, maximum * docs(random) : Add docs about random function * docs(random): Add docs about random function * docs(random): Fix documentation typos * docs(random): Fix documentation typos * docs(random): Fix spacing * docs(random): Fix spacing * docs(random): Update interface heading * docs(random): Update interface heading * fix(random): Validate input parameters and throw error for invalid ranges * test(random) : Update tests for new input validation logic * docs(random) : Update documentation for new input validation logic 2024-06-15 09:20:54 +03:00
feat(random, randomInt): Accept singular argument 2024-06-30 06:24:38 +03:00			If only one argument is provided, a number between `0` and the given number is returned.

feat(random): Adds a function that generates a random floating-point number between the minimum and maximum. (#53) * feat(random): Add generating a random floating-point number between min and max * test(random) : Add tests for random function * feat : Add random function to math module * test : Add benchmark for random function * refactor : Change the words min, max to minimum, maximum * docs(random) : Add docs about random function * docs(random): Add docs about random function * docs(random): Fix documentation typos * docs(random): Fix documentation typos * docs(random): Fix spacing * docs(random): Fix spacing * docs(random): Update interface heading * docs(random): Update interface heading * fix(random): Validate input parameters and throw error for invalid ranges * test(random) : Update tests for new input validation logic * docs(random) : Update documentation for new input validation logic 2024-06-15 09:20:54 +03:00			`## Signature`

			```typescript
feat(random, randomInt): Accept singular argument 2024-06-30 06:24:38 +03:00			`function random(maximum: number): number;`
feat(random): Adds a function that generates a random floating-point number between the minimum and maximum. (#53) * feat(random): Add generating a random floating-point number between min and max * test(random) : Add tests for random function * feat : Add random function to math module * test : Add benchmark for random function * refactor : Change the words min, max to minimum, maximum * docs(random) : Add docs about random function * docs(random): Add docs about random function * docs(random): Fix documentation typos * docs(random): Fix documentation typos * docs(random): Fix spacing * docs(random): Fix spacing * docs(random): Update interface heading * docs(random): Update interface heading * fix(random): Validate input parameters and throw error for invalid ranges * test(random) : Update tests for new input validation logic * docs(random) : Update documentation for new input validation logic 2024-06-15 09:20:54 +03:00			`function random(minimum: number, maximum: number): number;`
			```

			`### Parameters`

			- `minimum` (`number`): The lower bound for the random number (inclusive).
			- `maximum` (`number`): The upper bound for the random number (exclusive).

			`### Returns`

docs(random, randomInt): Add docs for randomInt, and polish docs for random 2024-06-15 10:00:20 +03:00			- (`number`): A random number within the specified range. The number can be an integer or a decimal.
feat(random): Adds a function that generates a random floating-point number between the minimum and maximum. (#53) * feat(random): Add generating a random floating-point number between min and max * test(random) : Add tests for random function * feat : Add random function to math module * test : Add benchmark for random function * refactor : Change the words min, max to minimum, maximum * docs(random) : Add docs about random function * docs(random): Add docs about random function * docs(random): Fix documentation typos * docs(random): Fix documentation typos * docs(random): Fix spacing * docs(random): Fix spacing * docs(random): Update interface heading * docs(random): Update interface heading * fix(random): Validate input parameters and throw error for invalid ranges * test(random) : Update tests for new input validation logic * docs(random) : Update documentation for new input validation logic 2024-06-15 09:20:54 +03:00
			`## Examples`

			```typescript
docs(random, randomInt): Add docs for randomInt, and polish docs for random 2024-06-15 10:00:20 +03:00			`const result1 = random(0, 5); // Returns a random number between 0 and 5.`
feat(random): Adds a function that generates a random floating-point number between the minimum and maximum. (#53) * feat(random): Add generating a random floating-point number between min and max * test(random) : Add tests for random function * feat : Add random function to math module * test : Add benchmark for random function * refactor : Change the words min, max to minimum, maximum * docs(random) : Add docs about random function * docs(random): Add docs about random function * docs(random): Fix documentation typos * docs(random): Fix documentation typos * docs(random): Fix spacing * docs(random): Fix spacing * docs(random): Update interface heading * docs(random): Update interface heading * fix(random): Validate input parameters and throw error for invalid ranges * test(random) : Update tests for new input validation logic * docs(random) : Update documentation for new input validation logic 2024-06-15 09:20:54 +03:00			`const result2 = random(5, 0); // If the minimum is greater than the maximum, an error is thrown`
			`const result3 = random(5, 5); // If the minimum is equal to the maximum, an error is thrown.`
			```