summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/location/street.md
blob: 91ec1bac87c84f00f93c4e7338a03df1968b4b9a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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'`.