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/natural.md | |
download | langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2 langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip |
Commit
Diffstat (limited to 'src/node_modules/chance/docs/basics/natural.md')
-rw-r--r-- | src/node_modules/chance/docs/basics/natural.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/basics/natural.md b/src/node_modules/chance/docs/basics/natural.md new file mode 100644 index 0000000..2127341 --- /dev/null +++ b/src/node_modules/chance/docs/basics/natural.md @@ -0,0 +1,47 @@ +# natural + +```js +// usage +chance.natural() +chance.natural({ min: 1, max: 20 }) +``` + +Return a natural number. + +_range: 0 to 9007199254740991_ + +```js + chance.natural(); + => 125019392395 +``` + +Can optionally provide min and max. + +```js +chance.natural({min: 1, max: 20}); +=> 14 +``` + +Can optionally provide numbers you wish to exclude. + +```js +chance.natural({min: 1, max: 5, exclude: [1, 3]}); +=> 2 +``` + +These are inclusive, so they are included in the range. This means +```chance.natural({min: 1, max: 3});``` would return either 1, 2, or 3 or: + +```js +// Specific case +1 <= random number <= 3 + +// General case +min <= random number <= max +``` + + +[Natural Number on Wikipedia][natural] + +[natural]: https://en.wikipedia.org/wiki/Natural_number + |