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

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

diff --git a/src/node_modules/chance/docs/location/state.md b/src/node_modules/chance/docs/location/state.md
new file mode 100644
index 0000000..81a200b
--- /dev/null
+++ b/src/node_modules/chance/docs/location/state.md
@@ -0,0 +1,62 @@
+# state
+
+```js
+// usage
+chance.state()
+chance.state({ full: true })
+chance.state({ territories: true })
+chance.state({ armed_forces: true })
+chance.state({ us_states_and_dc: false })
+chance.state({ country: 'us' })
+```
+
+Return a random state.
+
+```js
+chance.state();
+=> 'AK'
+```
+
+By default, returns only the 2 letter abbreviation for state.
+
+Optionally specify that it ought to return a full state name.
+
+```js
+chance.state({ full: true });
+=> 'Florida'
+```
+
+Optionally add U.S. Territories ('American Samoa', 'Federated States of Micronesia', 'Guam', 'Marshall Islands', 'Northern Mariana Islands', 'Puerto Rico', 'Virgin Islands, U.S.') to the mix of randomly selected items:
+
+```js
+chance.state({ territories: true, full: true })
+=> 'Guam'
+```
+
+Optionally add Armed Forces to the list as well:
+
+```js
+chance.state({ armed_forces: true, full: true })
+=> 'Armed Forces Pacific'
+```
+
+For all U.S. states, territories, and armed forces, specify all of them:
+
+```js
+chance.state({ armed_forces: true, territories: true })
+=> 'NY'
+```
+
+For just territories or armed forces, specify that it ought not return U.S. states:
+
+```js
+chance.state({ territories: true, us_states_and_dc: false })
+=> 'PR'
+```
+
+Optionally specify a country (US specific options are ignored if country is specified and different from `'us'`):
+
+```js
+chance.state({ country: 'it', full: true })
+=> 'Toscana'
+```
-- 
cgit