From 46e43f4bde4a35785b4997b81e86cd19f046b69b Mon Sep 17 00:00:00 2001
From: Minteck <contact@minteck.org>
Date: Tue, 21 Dec 2021 16:52:28 +0100
Subject: Commit

---
 src/node_modules/chance/docs/thing/animal.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 src/node_modules/chance/docs/thing/animal.md

(limited to 'src/node_modules/chance/docs/thing')

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`
-- 
cgit