@monstermann/fn/dist/number/randomInt.d.ts

A utility library for TypeScript.

//#region src/number/randomInt.d.ts
/**
 * `randomInt(start, end)`
 *
 * Returns a random integer within the range between `start` and `end` (inclusive). The order of `start` and `end` does not matter.
 *
 * ```ts
 * randomInt(1, 10); // random integer between 1 and 10
 * randomInt(10, 1); // random integer between 1 and 10
 * randomInt(0, 5); // random integer between 0 and 5
 * ```
 *
 * ```ts
 * pipe(1, randomInt(10)); // random integer between 1 and 10
 * pipe(10, randomInt(1)); // random integer between 1 and 10
 * pipe(0, randomInt(5)); // random integer between 0 and 5
 * ```
 */
declare const randomInt: {
  (end: number): (start: number) => number;
  (start: number, end: number): number;
};
//#endregion
export { randomInt };