summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/time/year.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/year.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/chance/docs/time/year.md')
-rw-r--r--src/node_modules/chance/docs/time/year.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/time/year.md b/src/node_modules/chance/docs/time/year.md
new file mode 100644
index 0000000..4ef4527
--- /dev/null
+++ b/src/node_modules/chance/docs/time/year.md
@@ -0,0 +1,31 @@
+# year
+
+```js
+// usage
+chance.year()
+chance.year({min: 1900, max: 2100})
+```
+
+Generate a random year
+
+```js
+chance.year();
+=> '2053'
+```
+
+By default, min is the current year and max is 100 years greater than min.
+
+This is returned as a string. If for some reason you need it numeric, just
+parse it:
+
+```js
+parseInt(chance.year());
+=> 2042
+```
+
+Optionally specify min, max, or both to limit the range.
+
+```js
+chance.year({min: 1900, max: 2100});
+=> '1983'
+```