From 46e43f4bde4a35785b4997b81e86cd19f046b69b Mon Sep 17 00:00:00 2001 From: Minteck Date: Tue, 21 Dec 2021 16:52:28 +0100 Subject: Commit --- src/node_modules/chance/docs/location/province.md | 33 +++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 src/node_modules/chance/docs/location/province.md (limited to 'src/node_modules/chance/docs/location/province.md') 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'`. -- cgit