Random overview

Added in v2.0.0

---

Table of contents

• utils
  • random
  • randomBool
  • randomElem
  • randomInt
  • randomRange

---

utils

random

Returns a random number between 0 (inclusive) and 1 (exclusive). This is a direct wrapper around JavaScript’s Math.random().

Signature

export declare const random: IO<number>

Added in v2.0.0

randomBool

Returns a random boolean value with an equal chance of being true or false

Signature

export declare const randomBool: IO<boolean>

Added in v2.0.0

randomElem

Returns a random element of a ReadonlyNonEmptyArray.

Signature

export declare const randomElem: <A>(as: ReadonlyNonEmptyArray<A>) => IO<A>

Added in v2.10.0

randomInt

Takes a range specified by low (the first argument) and high (the second), and returns a random integer uniformly distributed in the closed interval [low, high]. It is unspecified what happens if low > high, or if either of low or high is not an integer.

Signature

export declare function randomInt(low: number, high: number): IO<number>

Added in v2.0.0

randomRange

Returns a random number between a minimum value (inclusive) and a maximum value (exclusive). It is unspecified what happens if maximum < minimum.

Signature

export declare function randomRange(min: number, max: number): IO<number>

Added in v2.0.0