From 46e43f4bde4a35785b4997b81e86cd19f046b69b Mon Sep 17 00:00:00 2001 From: Minteck Date: Tue, 21 Dec 2021 16:52:28 +0100 Subject: Commit --- src/node_modules/chance/docs/basics/bool.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 src/node_modules/chance/docs/basics/bool.md (limited to 'src/node_modules/chance/docs/basics/bool.md') diff --git a/src/node_modules/chance/docs/basics/bool.md b/src/node_modules/chance/docs/basics/bool.md new file mode 100644 index 0000000..e5b6a88 --- /dev/null +++ b/src/node_modules/chance/docs/basics/bool.md @@ -0,0 +1,24 @@ +# bool + +```js + // usages + chance.bool() + chance.bool({ likelihood: 30 }) +``` +Return a random boolean value (`true` or `false`). + +```js +chance.bool(); +=> true +``` + +The default likelihood of success (returning `true`) is 50%. +Can optionally specify the likelihood in percent: + +```js +chance.bool({likelihood: 30}); +=> false +``` + +In this case only a 30% likelihood of `true`, and a 70% likelihood of `false`. + -- cgit