diff options
author | Minteck <contact@minteck.org> | 2021-12-21 16:52:28 +0100 |
---|---|---|
committer | Minteck <contact@minteck.org> | 2021-12-21 16:52:28 +0100 |
commit | 46e43f4bde4a35785b4997b81e86cd19f046b69b (patch) | |
tree | c53c2f826f777f9d6b2d249dab556feb72a6c3a6 /src/node_modules/chance/docs/basics/prime.md | |
download | langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2 langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip |
Commit
Diffstat (limited to 'src/node_modules/chance/docs/basics/prime.md')
-rw-r--r-- | src/node_modules/chance/docs/basics/prime.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/basics/prime.md b/src/node_modules/chance/docs/basics/prime.md new file mode 100644 index 0000000..a7a45fd --- /dev/null +++ b/src/node_modules/chance/docs/basics/prime.md @@ -0,0 +1,41 @@ +# prime + +```js +// usage +chance.prime() +chance.prime({ min: 1, max: 20 }) +``` + +Return a prime number. + +_default range: 0 to 10000_ + +```js + chance.prime(); + => 929 +``` + +Can optionally provide min and max. + +```js +chance.prime({min: 1, max: 20}); +=> 13 +``` + + +These are inclusive, so they are included in the range. This means +```chance.prime({min: 2, max: 5});``` would return either 2, 3, or 5 or: + +```js +// Specific case +2 <= random number <= 5 + +// General case +min <= random number <= max +``` + + +[Prime Number on Wikipedia][prime] + +[prime]: https://en.wikipedia.org/wiki/Prime_number + |