@studiometa/js-toolkit/utils/random.d.ts

A set of useful little bits of JavaScript to boost your project! 🚀

/**
 * Get a random number between given bounds.
 * @param  {number} a   First bound.
 * @param  {number} [b] Second bound, defaults to 0.
 * @return {number} A number between `a` and `b`.
 * @link https://js-toolkit.studiometa.dev/utils/random.html
*/
export declare function random(a: number, b?: number): number;
/**
 * Get a random integer between bounds
 *
 * @param {number} a First bound.
 * @param {number} b Second bound.
 * @return {number} An integer between `a` and `b`;
 * @link https://js-toolkit.studiometa.dev/utils/randomInt.html
*/
export declare function randomInt(a: number, b?: number): number;
/**
 * Get a random item of an array or a random character of a string
 *
 * @param {T[] | string} items Array or string
 * @return {T | undefined}
 * @throws {Error} Throws an error if `items` is not an array or a string.
 * @link https://js-toolkit.studiometa.dev/utils/randomItem.html
*/
export declare function randomItem<T>(items: T[] | string): T | string | undefined;