2.0.0 • Published 3 years ago

@freddyheppell/random-prime v2.0.0

Weekly downloads
10
License
MIT
Repository
github
Last release
3 years ago

⚠️ This fork has been deprecated as the original random-prime library has been fixed. Consider using it instead ⚠️

random-prime

npm Build Status XO code style

Generate a random prime number

This uses Math.random internally.

Install

npm i @freddyheppell/random-prime --save

Example

const randomPrime = require('random-prime').randomPrime;

console.log(randomPrime());
// 254205915209711
console.log(randomPrime(500));
// 119
console.log(randomPrime(200, 800));
// 413

API

randomPrime()

Generate a random prime number from 0 to Number.MAX_SAFE_INTEGER.

Returns a prime number

randomPrime(max)

Generate a random prime number from 0 to max.

Returns a prime number or null if max < 2
Throws TypeError if max is not a Number

randomPrime(min, max)

Generate a random prime number from min to max.

Returns a prime number or null if there is no prime number between min and max
Throws TypeError if min and/or max is not a Number

isPrime(num)

An efficient method to check i a number is prime.

Returns true if num is prime, false if num is not prime.
Throws TypeError if input is not a Number

Example

const isPrime = require('random-prime').isPrime;

console.log(isPrime(2));
// true
console.log(isPrime(254205915209711));
// true
console.log(isPrime(500));
// false
console.log(isPrime(-10));
// false
console.log(isPrime(137));
// true