UNPKG

es-toolkit

Version:

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

es-toolkit.dev

toss/es-toolkit

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