summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/usage/function.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
committerMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
commit46e43f4bde4a35785b4997b81e86cd19f046b69b (patch)
treec53c2f826f777f9d6b2d249dab556feb72a6c3a6 /src/node_modules/chance/docs/usage/function.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/chance/docs/usage/function.md')
-rw-r--r--src/node_modules/chance/docs/usage/function.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/usage/function.md b/src/node_modules/chance/docs/usage/function.md
new file mode 100644
index 0000000..a79ccde
--- /dev/null
+++ b/src/node_modules/chance/docs/usage/function.md
@@ -0,0 +1,22 @@
+# function
+
+Instead of providing a seed, which will be used to seed our [Mersenne Twister](https://en.wikipedia.org/wiki/Mersenne_twister),
+you can also specify an arbitrary function to generate random numbers which the
+rest of the library will utilize when generating everything else.
+
+A rather simple example, simply using Math.random() instead of our Mersenne Twister
+
+```js
+// Use Math.random() instead of our Mersenne Twister
+var chance = new Chance(Math.random);
+
+chance.address()
+=> '131 Asmun Pike'
+chance.address()
+=> '261 Pawnaf Highway'
+```
+
+Chance will appear to work just the same, but have a different underlying random
+generator.
+
+This function should return any number between 0 and 1.