| 1 | /**
|
|---|
| 2 | * Generate a random number between 0 and 1.
|
|---|
| 3 | * @param {boolean} [floating] - Whether to return a floating point number. Defaults to true.
|
|---|
| 4 | * @returns {number} A random number between 0 and 1.
|
|---|
| 5 | * @example
|
|---|
| 6 | * random(); // Returns a random number between 0 and 1
|
|---|
| 7 | * random(true); // Returns a random floating point number between 0 and 1
|
|---|
| 8 | * random(false); // Returns a random integer between 0 and 1
|
|---|
| 9 | */
|
|---|
| 10 | declare function random(floating?: boolean): number;
|
|---|
| 11 | /**
|
|---|
| 12 | * Generate a random number between 0 and max.
|
|---|
| 13 | * @param {number} max - The upper bound (exclusive).
|
|---|
| 14 | * @param {boolean} [floating] - Whether to return a floating point number. Defaults to true.
|
|---|
| 15 | * @returns {number} A random number between 0 and max.
|
|---|
| 16 | * @example
|
|---|
| 17 | * random(5); // Returns a random number between 0 and 5
|
|---|
| 18 | * random(10, true); // Returns a random floating point number between 0 and 10
|
|---|
| 19 | * random(3, false); // Returns a random integer between 0 and 3
|
|---|
| 20 | */
|
|---|
| 21 | declare function random(max: number, floating?: boolean): number;
|
|---|
| 22 | /**
|
|---|
| 23 | * Generate a random number between min and max.
|
|---|
| 24 | * @param {number} min - The lower bound (inclusive).
|
|---|
| 25 | * @param {number} max - The upper bound (exclusive).
|
|---|
| 26 | * @param {boolean} [floating] - Whether to return a floating point number. Defaults to true.
|
|---|
| 27 | * @returns {number} A random number between min and max.
|
|---|
| 28 | * @example
|
|---|
| 29 | * random(1, 5); // Returns a random number between 1 and 5
|
|---|
| 30 | * random(0, 10, true); // Returns a random floating point number between 0 and 10
|
|---|
| 31 | * random(1, 6, false); // Returns a random integer between 1 and 6
|
|---|
| 32 | */
|
|---|
| 33 | declare function random(min: number, max: number, floating?: boolean): number;
|
|---|
| 34 | /**
|
|---|
| 35 | * Generate a random number between 0 and min, using guard object for special cases.
|
|---|
| 36 | * @param {number} min - The upper bound (exclusive).
|
|---|
| 37 | * @param {string | number} index - The index or key to check in the guard object.
|
|---|
| 38 | * @param {object} guard - The guard object to validate the parameters.
|
|---|
| 39 | * @returns {number} A random number between 0 and min.
|
|---|
| 40 | * @example
|
|---|
| 41 | * const guard = { 5: 5 };
|
|---|
| 42 | * random(5, 5, guard); // Returns a random number between 0 and 5
|
|---|
| 43 | */
|
|---|
| 44 | declare function random(min: number, index: string | number, guard: object): number;
|
|---|
| 45 |
|
|---|
| 46 | export { random };
|
|---|
