Module rand

Index

Functions

Functions

randomElement

randomElement<T>(arr: T[]): Promise<T>

- Defined in rand.ts:83
Pick a random element from an array.

Type parameters
- T
Parameters
- arr: T[]
  
  The array to get the element from.
Returns Promise<T>
A promise resolving to a random element from the input array.

randomElementSync

randomElementSync<T>(arr: T[]): T

- Defined in rand.ts:92
Pick a random element from an array.

Type parameters
- T
Parameters
- arr: T[]
  
  The array to get the element from.
Returns T
A random element from the input array.

range

range(max: number, min?: number): Promise<number>

- Defined in rand.ts:26
Generate a random value in a range (inclusive).

Parameters
- max: number
  
  The maximum value.
- min: number = 0
  
  The minimum value.
Returns Promise<number>
A promise resolving to a random number.

rangeInt

rangeInt(max: number, min?: number): Promise<number>

- Defined in rand.ts:46
Generate a random value in a range (inclusive) and round the result to the nearest whole number.

Parameters
- max: number
  
  The maximum value.
- min: number = 0
  
  The minimum value.
Returns Promise<number>
A promise resolving to a random whole number.

rangeIntSync

rangeIntSync(max: number, min?: number): number

- Defined in rand.ts:56
Generate a random value in a range (inclusive) and round the result to the nearest whole number.

Parameters
- max: number
  
  The maximum value.
- min: number = 0
  
  The minimum value.
Returns number
A random whole number.

rangeSync

rangeSync(max: number, min?: number): number

- Defined in rand.ts:36
Generate a random value in a range (inclusive).

Parameters
- max: number
  
  The maximum value.
- min: number = 0
  
  The minimum value.
Returns number
A random number.

rbool

rbool(weight?: number): Promise<boolean>

- Defined in rand.ts:65
Generate a random weighted boolean.

Parameters
- weight: number = 0.5
  
  The chance that the result will be true.
Returns Promise<boolean>
A promise resolving to a random boolean value.

rboolSync

rboolSync(weight?: number): boolean

- Defined in rand.ts:74
Generate a random weighted boolean.

Parameters
- weight: number = 0.5
  
  The chance that the result will be true.
Returns boolean
A random boolean value.

srand

srand(): Promise<number>

- Defined in rand.ts:8
Generate a random value between 0.0 and 1.0 using a 64-bit crypto generated value.

Returns Promise<number>
A promise resolving to a random number.

srandSync

srandSync(): number

- Defined in rand.ts:16
Generate a random value between 0.0 and 1.0 using a 64-bit crypto generated value.

Returns number
A random number.

Generated using TypeDoc