summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/location/province.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/location/province.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/chance/docs/location/province.md')
-rw-r--r--src/node_modules/chance/docs/location/province.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/location/province.md b/src/node_modules/chance/docs/location/province.md
new file mode 100644
index 0000000..bf07618
--- /dev/null
+++ b/src/node_modules/chance/docs/location/province.md
@@ -0,0 +1,33 @@
+# province
+
+```js
+// usage
+chance.province()
+chance.province({full: true})
+chance.province({full: true})
+```
+
+Return a random province.
+
+```js
+chance.province();
+=> 'ON'
+```
+
+By default, returns only the 2 letter abbreviation for province.
+
+Optionally specify that it ought to return a full province name.
+
+```js
+chance.province({full: true});
+=> 'Nova Scotia'
+```
+
+Optionally specify the country from which it should return the province name.
+
+```js
+chance.province({country: 'it', full: true});
+=> 'Vicenza'
+```
+
+Note, currently support for country is limited to: `'ca', 'it'`.