@newdash/newdash/random.d.ts

javascript/typescript utility library

/**
 * Produces a random number between the inclusive `lower` and `upper` bounds.
 * If only one argument is provided a number between `0` and the given number
 * is returned. If `floating` is `true`, or either `lower` or `upper` are
 * floats, a floating-point number is returned instead of an integer.
 *
 * **Note:** JavaScript follows the IEEE-754 standard for resolving
 * floating-point values which can produce unexpected results.
 *
 * @since 5.5.0
 * @category Number
 * @param lower The lower bound.
 * @param upper The upper bound.
 * @param floating Specify returning a floating-point number.
 * @returns Returns the random number.
 * @see [[uniqueId]]
 * @example
 *
 * ```js
 * random(0, 5)
 * // => an integer between 0 and 5
 *
 * random(5)
 * // => also an integer between 0 and 5
 *
 * random(5, true)
 * // => a floating-point number between 0 and 5
 *
 * random(1.2, 5.2)
 * // => a floating-point number between 1.2 and 5.2
 * ```
 */
declare function random(floating?: boolean): number;
declare function random(upper?: number | string, floating?: boolean): number;
declare function random(lower?: number | string, upper?: number | string, floating?: boolean): number;
export { random };
export default random;