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

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

diff --git a/src/node_modules/chance/docs/location/street.md b/src/node_modules/chance/docs/location/street.md
new file mode 100644
index 0000000..91ec1ba
--- /dev/null
+++ b/src/node_modules/chance/docs/location/street.md
@@ -0,0 +1,37 @@
+# street
+
+```js
+// usage
+chance.street()
+chance.street({country:it})
+```
+
+Generate a random street
+
+```js
+chance.street();
+=> 'Tesca Circle'
+```
+
+Optionally mandate that it returns a short suffix
+
+```js
+chance.street({short_suffix: true});
+=> 'Jiled St'
+```
+
+Optionally specify the number of syllables used to generate the street name
+
+```js
+chance.street({syllables: 8});
+=> 'Teniefitinusewjircor Junction'
+```
+
+Optionally specify a country to localize street prefixes
+
+```js
+chance.street({country: 'it'});
+=> 'Via Nefba'
+```
+
+Note, currently support for country is limited to: `'us', 'it'`.
-- 
cgit