-
Notifications
You must be signed in to change notification settings - Fork 14
/
faker.address-api.html
197 lines (183 loc) · 7.64 KB
/
faker.address-api.html
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
<html>
<head>
<title>faker.address API reference (faker)</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
<!-- TODO: are we using these (from clojure.org)? If so, add the files -->
<script src="file/view/code_highlighter.js" type="text/javascript"></script>
<script src="file/view/clojure.js" type="text/javascript"></script>
<style>.menuWrapper{height: 36px;}</style>
<!--[if lte IE 6]>
<link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
<![endif]-->
</head>
<!--
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
<body>
<div id="AllContentContainer">
<div id="Header">
<a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
<h1><a title="page header title" id="page-header" href="index.html">faker</a></h1>
</div>
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<a class="wiki_link" href="index.html">Overview</a><br />
<a class="wiki_link" href="api-index.html">API Index</a><br />
<a class="wiki_link" href="#">Namespaces:</a>
<ul id="left-sidebar-list">
<li><a href="faker.address-api.html" class="wiki_link">faker.address</a></li><li><a href="faker.address-data-api.html" class="wiki_link">faker.address-data</a></li><li><a href="faker.company-api.html" class="wiki_link">faker.company</a></li><li><a href="faker.company-data-api.html" class="wiki_link">faker.company-data</a></li><li><a href="faker.internet-api.html" class="wiki_link">faker.internet</a></li><li><a href="faker.lorem-api.html" class="wiki_link">faker.lorem</a></li><li><a href="faker.lorem-data-api.html" class="wiki_link">faker.lorem-data</a></li><li><a href="faker.name-api.html" class="wiki_link">faker.name</a></li><li><a href="faker.name-data-api.html" class="wiki_link">faker.name-data</a></li><li><a href="faker.phone-number-api.html" class="wiki_link">faker.phone-number</a></li>
</ul>
</div>
</div>
</div>
<div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
<div id="content_view" class="wiki wikiPage">
<div id="right-sidebar"><div id="toc">
<h1 class="nopad">Table of Contents</h1>
<div style="margin-left: 1em;" class="toc-section">
<a href="#toc0">Overview</a>
<div style="margin-left: 1em;" class="toc-entry">
<a href="#faker.address/city-prefix">city-prefix</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#faker.address/city-suffix">city-suffix</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#faker.address/street-address">street-address</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#faker.address/street-suffix">street-suffix</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#faker.address/uk-country">uk-country</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#faker.address/uk-county">uk-county</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#faker.address/uk-postcode">uk-postcode</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#faker.address/us-state">us-state</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#faker.address/us-state-abbr">us-state-abbr</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#faker.address/zip-code">zip-code</a>
</div>
<br />
</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">faker.address</span></h1>
by <span id="author">Unknown</span><br />
<br />Usage:
<pre>
(ns your-namespace
(:require <span id="long-name">faker.address</span>))
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr">Create fake address data.</pre>
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="faker.address/city-prefix">city-prefix</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (city-prefix)
</pre>
<pre id="var-docstr">Returns a random city prefix, like North or South.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="faker.address/city-suffix">city-suffix</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (city-suffix)
</pre>
<pre id="var-docstr">Returns a random city suffix, like town or land.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="faker.address/street-address">street-address</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (street-address)
(street-address include-secondary?)
</pre>
<pre id="var-docstr">Returns a random address.
If include-secondary? is true the address will include a secondary part.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="faker.address/street-suffix">street-suffix</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (street-suffix)
</pre>
<pre id="var-docstr">Returns a random street suffix, like Avenue or Bridge.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="faker.address/uk-country">uk-country</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (uk-country)
</pre>
<pre id="var-docstr">Return a random UK country.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="faker.address/uk-county">uk-county</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (uk-county)
</pre>
<pre id="var-docstr">Return a random UK county.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="faker.address/uk-postcode">uk-postcode</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (uk-postcode)
</pre>
<pre id="var-docstr">Return a random UK postcode.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="faker.address/us-state">us-state</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (us-state)
</pre>
<pre id="var-docstr">Returns a random USA state.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="faker.address/us-state-abbr">us-state-abbr</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (us-state-abbr)
</pre>
<pre id="var-docstr">Returns a random USA state abbreviation.</pre>
</div><div id="var-entry">
<br />
<hr />
<h2 id="faker.address/zip-code">zip-code</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (zip-code)
</pre>
<pre id="var-docstr">Create a random USA zip code.</pre>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">No copyright info </div>
</div>
</div>
<div id="DesignedBy">Logo & site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
Clojure auto-documentation system by Tom Faulhaber.</div>
</div>
<!-- /AllContentContainer -->
</body>
</html>