doc/faker.address.html

<!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">&lt;static> </span>city(format)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Generates a random localized city name. The format string can contain any
method provided by faker wrapped in <code>{{}}</code>, e.g. <code>{{name.firstName}}</code> in
order 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">&lt;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">&lt;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">&lt;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">&lt;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">&lt;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">&lt;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">&lt;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">&lt;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">&lt;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">&lt;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">&lt;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">&lt;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">&lt;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">&lt;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">&lt;static> </span>zipCode(format)</h4>
    
    
</dt>
<dd>

    
    <div class="description">
        <p>Generates random zipcode from format. If format is not specified, the
locale'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">&times;</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>