summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/time/hour.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/time/hour.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/chance/docs/time/hour.md')
-rw-r--r--src/node_modules/chance/docs/time/hour.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/time/hour.md b/src/node_modules/chance/docs/time/hour.md
new file mode 100644
index 0000000..02e06d0
--- /dev/null
+++ b/src/node_modules/chance/docs/time/hour.md
@@ -0,0 +1,27 @@
+# hour
+
+```js
+// usage
+chance.hour()
+chance.hour({twentyfour: true})
+```
+
+Generate a random hour
+
+```js
+chance.hour();
+=> 9
+```
+
+By default, returns an hour from 1 to 12 for a standard [12-hour clock][12h].
+
+Can optionally specify a full twenty-four.
+
+```js
+chance.hour({twentyfour: true});
+=> 21
+```
+
+This will return an hour from 1 to 24.
+
+[12h]: https://en.wikipedia.org/wiki/12-hour_clock