function randomInt

Overload 1

#randomInt(max: number): number

Return a random integer n such that min <= n < max. This implementation avoids modulo bias.

The range (max - min) must be less than 2**48. min and max must be safe integers.

If the callback function is not provided, the random integer is generated synchronously.

// Asynchronous
const {
  randomInt,
} = await import('node:crypto');

randomInt(3, (err, n) => {
  if (err) throw err;
  console.log(`Random number chosen from (0, 1, 2): ${n}`);
});

// Synchronous
const {
  randomInt,
} = await import('node:crypto');

const n = randomInt(3);
console.log(`Random number chosen from (0, 1, 2): ${n}`);

// With `min` argument
const {
  randomInt,
} = await import('node:crypto');

const n = randomInt(1, 7);
console.log(`The dice rolled: ${n}`);

Parameters #

#max: number

End of random range (exclusive).

Return Type #

number

Overload 2

#randomInt(min: number,
max: number,
): number

Parameters #

#min: number

#max: number

Return Type #

number

Overload 3

#randomInt(max: number,
callback: (err: Error | null,
value: number,
) => void,
): void

Parameters #

#max: number

#callback: (err: Error | null,
value: number,
) => void

Return Type #

void

Overload 4

#randomInt(min: number,
max: number,
callback: (err: Error | null,
value: number,
) => void,
): void

Parameters #

#min: number

#max: number

#callback: (err: Error | null,
value: number,
) => void

Return Type #

void