summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/thing/animal.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/thing/animal.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/chance/docs/thing/animal.md')
-rw-r--r--src/node_modules/chance/docs/thing/animal.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/thing/animal.md b/src/node_modules/chance/docs/thing/animal.md
new file mode 100644
index 0000000..de7f9c0
--- /dev/null
+++ b/src/node_modules/chance/docs/thing/animal.md
@@ -0,0 +1,25 @@
+# animal
+
+```js
+// usage
+chance.animal()
+chance.animal({type: 'zoo'})
+```
+
+Generate a random animal
+
+```js
+chance.animal();
+=> 'Cobra'
+```
+
+Default is any type of animal.
+
+Optionally specify a specific type of animal
+
+```js
+chance.animal({type: 'zoo'});
+=> 'Lion'
+```
+
+Allowed types are: `ocean`, `desert`, `grassland`, `forest`, `farm`, `pet`, and `zoo`