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/location/depth.md | 29 ++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 src/node_modules/chance/docs/location/depth.md

(limited to 'src/node_modules/chance/docs/location/depth.md')

diff --git a/src/node_modules/chance/docs/location/depth.md b/src/node_modules/chance/docs/location/depth.md
new file mode 100644
index 0000000..163c3ce
--- /dev/null
+++ b/src/node_modules/chance/docs/location/depth.md
@@ -0,0 +1,29 @@
+# depth
+
+```js
+// usage
+chance.depth()
+chance.depth({ fixed: 2 })
+chance.depth({ min: -1000 })
+```
+
+Generate a random depth, in meters. Depths are always negative
+
+```js
+chance.depth()
+=> -2126.95039
+```
+
+By default, includes 5 digits of accuracy after the decimal. Can override with the `fixed` option.
+
+```js
+chance.depth({ fixed: 2 })
+=> -1542.11
+```
+
+By default, maximum (or minimum depending on your frame of reference) depth of -2550 (depth of the Mariana Trench), but this can be overridden with the `min` option.
+
+```js
+chance.depth({ min: -1000 })
+=> -718.41976
+```
-- 
cgit