Skip to main content
Module

x/deno_faker/doc/faker.html

Deno port of https://github.com/Marak/faker.js
Extremely Popular
Go to Latest
File
<!DOCTYPE html>
<html lang="en"><head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> <title>Documentation Namespace: faker</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: faker</h1><section>
<header> <h2> faker </h2> </header>

<article> <div class="container-overview">
<dl class="details">

















</dl>

</div>




<h3 class="subsection-title">Namespaces</h3>
<dl> <dt><a href="namespaces.html#faker.address"><a href="faker.address.html">address</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.commerce"><a href="faker.commerce.html">commerce</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.company"><a href="faker.company.html">company</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.database"><a href="faker.database.html">database</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.date"><a href="faker.date.html">date</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.finance"><a href="faker.finance.html">finance</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.hacker"><a href="faker.hacker.html">hacker</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.helpers"><a href="faker.helpers.html">helpers</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.image"><a href="faker.image.html">image</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.internet"><a href="faker.internet.html">internet</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.lorem"><a href="faker.lorem.html">lorem</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.name"><a href="faker.name.html">name</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.phone"><a href="faker.phone.html">phone</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.random"><a href="faker.random.html">random</a></a></dt> <dd></dd> <dt><a href="namespaces.html#faker.system"><a href="faker.system.html">system</a></a></dt> <dd></dd> </dl>

<h3 class="subsection-title">Methods</h3>
<dl> <hr><dt> <h4 class="name" id=".fake"><span class="type-signature">&lt;static> </span>fake(str)</h4> </dt><dd>
<div class="description"> <p>Generator method for combining faker methods based on string input</p><p><strong>Example:</strong></p><pre class="prettyprint source"><code>console.log(faker.fake('{{name.lastName}}, {{name.firstName}} {{name.suffix}}'));//outputs: &quot;Marks, Dean Sr.&quot;</code></pre><p>This will interpolate the format string with the value of methods<a href="faker.name.html#.lastName">name.lastName</a>, <a href="faker.name.html#.firstName">name.firstName</a>,and <a href="faker.name.html#.suffix">name.suffix</a></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>str</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>