Extremely Popular
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739<!DOCTYPE html>
<html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> <title>Documentation Namespace: address</title>
<!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top "><div class="container"> <div class="navbar-header"> <a class="navbar-brand" href="index.html">Documentation</a> <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> </div> <div class="navbar-collapse collapse" id="topNavigation"> <ul class="nav navbar-nav"> <li class="dropdown"> <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a> <ul class="dropdown-menu "> <li><a href="faker.html">faker</a></li><li><a href="faker.address.html">faker.address</a></li><li><a href="faker.commerce.html">faker.commerce</a></li><li><a href="faker.company.html">faker.company</a></li><li><a href="faker.database.html">faker.database</a></li><li><a href="faker.date.html">faker.date</a></li><li><a href="faker.finance.html">faker.finance</a></li><li><a href="faker.hacker.html">faker.hacker</a></li><li><a href="faker.helpers.html">faker.helpers</a></li><li><a href="faker.image.html">faker.image</a></li><li><a href="faker.internet.html">faker.internet</a></li><li><a href="faker.lorem.html">faker.lorem</a></li><li><a href="faker.name.html">faker.name</a></li><li><a href="faker.phone.html">faker.phone</a></li><li><a href="faker.random.html">faker.random</a></li><li><a href="faker.system.html">faker.system</a></li> </ul> </li> </ul> <div class="col-sm-3 col-md-3"> <form class="navbar-form" role="search"> <div class="input-group"> <input type="text" class="form-control" placeholder="Search" name="q" id="search-input"> <div class="input-group-btn"> <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button> </div> </div> </form> </div> </div>
</div></div>
<div class="container" id="toc-content"><div class="row">
<div class="col-md-8"> <div id="main">
<h1 class="page-title">Namespace: address</h1><section>
<header> <h2> <span class="ancestors"><a href="faker.html">faker</a>.</span> address </h2> </header>
<article> <div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<dl> <hr><dt> <h4 class="name" id=".city"><span class="type-signature"><static> </span>city(format)</h4> </dt><dd>
<div class="description"> <p>Generates a random localized city name. The format string can contain anymethod provided by faker wrapped in <code>{{}}</code>, e.g. <code>{{name.firstName}}</code> inorder to build the city name.</p><p>If no format string is provided one of the following is randomly used:</p><ul><li><code>{{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}}</code></li><li><code>{{address.cityPrefix}} {{name.firstName}}</code></li><li><code>{{name.firstName}}{{address.citySuffix}}</code></li><li><code>{{name.lastName}}{{address.citySuffix}}</code></li></ul> </div>
<h5>Parameters:</h5>
<table class="params table table-striped"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>format</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
</tbody></table>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".cityPrefix"><span class="type-signature"><static> </span>cityPrefix()</h4> </dt><dd>
<div class="description"> <p>Return a random localized city prefix</p> </div>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".citySuffix"><span class="type-signature"><static> </span>citySuffix()</h4> </dt><dd>
<div class="description"> <p>Return a random localized city suffix</p> </div>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".country"><span class="type-signature"><static> </span>country()</h4> </dt><dd>
<div class="description"> <p>country</p> </div>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".countryCode"><span class="type-signature"><static> </span>countryCode()</h4> </dt><dd>
<div class="description"> <p>countryCode</p> </div>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".county"><span class="type-signature"><static> </span>county()</h4> </dt><dd>
<div class="description"> <p>county</p> </div>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".latitude"><span class="type-signature"><static> </span>latitude()</h4> </dt><dd>
<div class="description"> <p>latitude</p> </div>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".longitude"><span class="type-signature"><static> </span>longitude()</h4> </dt><dd>
<div class="description"> <p>longitude</p> </div>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".secondaryAddress"><span class="type-signature"><static> </span>secondaryAddress()</h4> </dt><dd>
<div class="description"> <p>secondaryAddress</p> </div>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".state"><span class="type-signature"><static> </span>state(useAbbr)</h4> </dt><dd>
<div class="description"> <p>state</p> </div>
<h5>Parameters:</h5>
<table class="params table table-striped"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>useAbbr</code></td>
<td class="type"> <span class="param-type">Boolean</span>
</td>
<td class="description last"></td> </tr>
</tbody></table>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".stateAbbr"><span class="type-signature"><static> </span>stateAbbr()</h4> </dt><dd>
<div class="description"> <p>stateAbbr</p> </div>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".streetAddress"><span class="type-signature"><static> </span>streetAddress(useFullAddress)</h4> </dt><dd>
<div class="description"> <p>Returns a random localized street address</p> </div>
<h5>Parameters:</h5>
<table class="params table table-striped"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>useFullAddress</code></td>
<td class="type"> <span class="param-type">Boolean</span>
</td>
<td class="description last"></td> </tr>
</tbody></table>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".streetName"><span class="type-signature"><static> </span>streetName()</h4> </dt><dd>
<div class="description"> <p>Returns a random localized street name</p> </div>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".streetPrefix"><span class="type-signature"><static> </span>streetPrefix()</h4> </dt><dd>
<div class="description"> <p>streetPrefix</p> </div>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".streetSuffix"><span class="type-signature"><static> </span>streetSuffix()</h4> </dt><dd>
<div class="description"> <p>streetSuffix</p> </div>
<dl class="details">
</dl>
</dd>
<hr><dt> <h4 class="name" id=".zipCode"><span class="type-signature"><static> </span>zipCode(format)</h4> </dt><dd>
<div class="description"> <p>Generates random zipcode from format. If format is not specified, thelocale's zip format is used.</p> </div>
<h5>Parameters:</h5>
<table class="params table table-striped"> <thead> <tr> <th>Name</th>
<th>Type</th>
<th class="last">Description</th> </tr> </thead>
<tbody>
<tr> <td class="name"><code>format</code></td>
<td class="type"> <span class="param-type">String</span>
</td>
<td class="description last"></td> </tr>
</tbody></table>
<dl class="details">
</dl>
</dd>
</dl>
</article>
</section>
</div> </div>
<div class="clearfix"></div>
<div class="col-md-3"> <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div> </div>
</div></div>
<div class="modal fade" id="searchResults"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button> <h4 class="modal-title">Search results</h4> </div> <div class="modal-body"></div> <div class="modal-footer"> <button type="button" class="btn btn-default" data-dismiss="modal">Close</button> </div> </div><!-- /.modal-content --> </div><!-- /.modal-dialog --></div>
<footer>
<span class="jsdoc-message"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on 2017-02-21T13:01:35-05:00 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.</span></footer>
<script src="scripts/docstrap.lib.js"></script><script src="scripts/toc.js"></script><script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>$( function () { $( "[id*='$']" ).each( function () { var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) ); } );
$( ".tutorial-section pre, .readme-section pre" ).each( function () { var $this = $( this );
var example = $this.find( "code" ); exampleText = example.html(); var lang = /{@lang (.*?)}/.exec( exampleText ); if ( lang && lang[1] ) { exampleText = exampleText.replace( lang[0], "" ); example.html( exampleText ); lang = lang[1]; } else { var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/); lang = langClassMatch ? langClassMatch[1] : "javascript"; }
if ( lang ) {
$this .addClass( "sunlight-highlight-" + lang ) .addClass( "linenums" ) .html( example.html() );
} } );
Sunlight.highlightAll( { lineNumbers : false, showMenu : true, enableDoclinks : true } );
$.catchAnchorLinks( { navbarOffset: 10 } ); $( "#toc" ).toc( { anchorName : function ( i, heading, prefix ) { var id = $( heading ).attr( "id" ); return id && id.replace(/\~/g, '-inner-').replace(/\./g, '-static-') || ( prefix + i ); }, selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4", showAndHide : false, smoothScrolling: true } );
$( "#main span[id^='toc']" ).addClass( "toc-shim" ); $( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () { var $this = $( this ); $this.addClass('table'); } );
} );</script>
<!--Navigation and Symbol Display-->
<!--Google Analytics-->
<script type="text/javascript"> $(document).ready(function() { SearcherDisplay.init(); });</script>
</body></html>