aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarak <[email protected]>2016-03-20 21:15:44 -0400
committerMarak <[email protected]>2016-03-20 21:15:44 -0400
commit7cddded9d18f571c3cd74b78dc57410f8b77697d (patch)
tree97cf8cfbd7318de3a0b7ce4e2b2b4852bee4e336 /doc
parent5993a8a8a471638c2af9a52eab6155bcde366d7e (diff)
downloadfaker-7cddded9d18f571c3cd74b78dc57410f8b77697d.tar.xz
faker-7cddded9d18f571c3cd74b78dc57410f8b77697d.zip
[dist] Re-build library for v3.1.0 release
Diffstat (limited to 'doc')
-rw-r--r--doc/faker.address.html2
-rw-r--r--doc/faker.commerce.html2
-rw-r--r--doc/faker.company.html2
-rw-r--r--doc/faker.date.html2
-rw-r--r--doc/faker.finance.html80
-rw-r--r--doc/faker.hacker.html2
-rw-r--r--doc/faker.helpers.html2
-rw-r--r--doc/faker.html2
-rw-r--r--doc/faker.image.html2
-rw-r--r--doc/faker.internet.html2
-rw-r--r--doc/faker.lorem.html2
-rw-r--r--doc/faker.name.html2
-rw-r--r--doc/faker.phone.html2
-rw-r--r--doc/faker.random.html80
-rw-r--r--doc/faker.system.html2
-rw-r--r--doc/index.html49
-rw-r--r--doc/namespaces.list.html2
-rw-r--r--doc/quicksearch.html2
18 files changed, 209 insertions, 30 deletions
diff --git a/doc/faker.address.html b/doc/faker.address.html
index 01d42655..2c11216f 100644
--- a/doc/faker.address.html
+++ b/doc/faker.address.html
@@ -1648,7 +1648,7 @@ locale's zip format is used.</p>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.commerce.html b/doc/faker.commerce.html
index a5cebf52..e68ea0ae 100644
--- a/doc/faker.commerce.html
+++ b/doc/faker.commerce.html
@@ -932,7 +932,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.company.html b/doc/faker.company.html
index 4197c108..68d41d1b 100644
--- a/doc/faker.company.html
+++ b/doc/faker.company.html
@@ -1098,7 +1098,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.date.html b/doc/faker.date.html
index d197b835..d89d5bba 100644
--- a/doc/faker.date.html
+++ b/doc/faker.date.html
@@ -1030,7 +1030,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.finance.html b/doc/faker.finance.html
index e879ea1c..44cd63c4 100644
--- a/doc/faker.finance.html
+++ b/doc/faker.finance.html
@@ -552,6 +552,84 @@
<hr>
<dt>
+ <h4 class="name" id=".bitcoinAddress"><span class="type-signature">&lt;static> </span>bitcoinAddress()</h4>
+
+
+</dt>
+<dd>
+
+
+ <div class="description">
+ <p>bitcoinAddress</p>
+ </div>
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</dd>
+
+
+
+<hr>
+<dt>
<h4 class="name" id=".currencyCode"><span class="type-signature">&lt;static> </span>currencyCode()</h4>
@@ -1084,7 +1162,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.hacker.html b/doc/faker.hacker.html
index 2e236b78..71df8c92 100644
--- a/doc/faker.hacker.html
+++ b/doc/faker.hacker.html
@@ -658,7 +658,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.helpers.html b/doc/faker.helpers.html
index bd61ec05..432aff46 100644
--- a/doc/faker.helpers.html
+++ b/doc/faker.helpers.html
@@ -1318,7 +1318,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.html b/doc/faker.html
index 1addfdcb..d5c965cd 100644
--- a/doc/faker.html
+++ b/doc/faker.html
@@ -367,7 +367,7 @@ and <a href="faker.name.html#.suffix">name.suffix</a></p>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.image.html b/doc/faker.image.html
index 3ce47c6b..93bd2629 100644
--- a/doc/faker.image.html
+++ b/doc/faker.image.html
@@ -2932,7 +2932,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.internet.html b/doc/faker.internet.html
index ff8f3647..e338aa52 100644
--- a/doc/faker.internet.html
+++ b/doc/faker.internet.html
@@ -1748,7 +1748,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.lorem.html b/doc/faker.lorem.html
index a1470b7b..314e21bc 100644
--- a/doc/faker.lorem.html
+++ b/doc/faker.lorem.html
@@ -1286,7 +1286,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.name.html b/doc/faker.name.html
index 0cdffa19..ff93158d 100644
--- a/doc/faker.name.html
+++ b/doc/faker.name.html
@@ -1218,7 +1218,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.phone.html b/doc/faker.phone.html
index 66ecaf04..865b19d1 100644
--- a/doc/faker.phone.html
+++ b/doc/faker.phone.html
@@ -518,7 +518,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.random.html b/doc/faker.random.html
index e9a79dd2..5311f285 100644
--- a/doc/faker.random.html
+++ b/doc/faker.random.html
@@ -146,6 +146,84 @@
<hr>
<dt>
+ <h4 class="name" id=".alphaNumeric"><span class="type-signature">&lt;static> </span>alphaNumeric()</h4>
+
+
+</dt>
+<dd>
+
+
+ <div class="description">
+ <p>alphaNumeric</p>
+ </div>
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</dd>
+
+
+
+<hr>
+<dt>
<h4 class="name" id=".arrayElement"><span class="type-signature">&lt;static> </span>arrayElement(array)</h4>
@@ -1166,7 +1244,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/faker.system.html b/doc/faker.system.html
index 7895578a..c6f7c14b 100644
--- a/doc/faker.system.html
+++ b/doc/faker.system.html
@@ -1218,7 +1218,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/index.html b/doc/index.html
index 0597f8ee..d2f906e4 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -103,13 +103,12 @@
var randomName = faker.name.findName(); // Rowan Nikolaus
var randomEmail = faker.internet.email(); // [email protected]
-var randomCard = faker.helpers.createCard(); // random contact card containing many properties</code></pre><h2>API</h2><h3>Faker.fake()</h3><p>As of version <code>v3.0.0</code> faker.js contains a super useful generator method <code>Faker.fake</code> for combining faker API methods using a mustache string format.</p>
+var randomCard = faker.helpers.createCard(); // random contact card containing many properties</code></pre><h2>API</h2><h3>Faker.fake()</h3><p>faker.js contains a super useful generator method <code>Faker.fake</code> for combining faker API methods using a mustache string format.</p>
<p><strong>Example:</strong></p>
-<pre class="prettyprint source lang-js"><code>console.log(faker.fake('{{name.lastName}}, {{name.firstName}} {{name.suffix}}'));
+<pre class="prettyprint source lang-js"><code>console.log(faker.fake(&quot;{{name.lastName}}, {{name.firstName}} {{name.suffix}}&quot;));
// outputs: &quot;Marks, Dean Sr.&quot;</code></pre><p>This will interpolate the format string with the value of methods <code>name.lastName()</code>, <code>name.firstName()</code>, and <code>name.suffix()</code></p>
-<h3>API Methods</h3><p>A documentation can be generated with <code>npm run-script doc</code>. The docs are put into <code>./doc</code>. Here is
-an overview of all api methods:</p>
-<ul>
+<h3>JSDoc API Browser</h3><p><a href="http://marak.github.io/faker.js/">http://marak.github.io/faker.js/</a></p>
+<h3>API Methods</h3><ul>
<li>address<ul>
<li>zipCode</li>
<li>city</li>
@@ -172,6 +171,7 @@ an overview of all api methods:</p>
<li>currencyCode</li>
<li>currencyName</li>
<li>currencySymbol</li>
+<li>bitcoinAddress</li>
</ul>
</li>
<li>hacker<ul>
@@ -218,6 +218,7 @@ an overview of all api methods:</p>
<li>internet<ul>
<li>avatar</li>
<li>email</li>
+<li>exampleEmail</li>
<li>userName</li>
<li>protocol</li>
<li>url</li>
@@ -232,11 +233,14 @@ an overview of all api methods:</p>
</ul>
</li>
<li>lorem<ul>
+<li>word</li>
<li>words</li>
<li>sentence</li>
<li>sentences</li>
<li>paragraph</li>
<li>paragraphs</li>
+<li>text</li>
+<li>lines</li>
</ul>
</li>
<li>name<ul>
@@ -264,18 +268,35 @@ an overview of all api methods:</p>
<li>objectElement</li>
<li>uuid</li>
<li>boolean</li>
+<li>word</li>
+<li>words</li>
+<li>image</li>
+<li>locale</li>
+<li>alphaNumeric</li>
</ul>
</li>
+<li>system<ul>
+<li>fileName</li>
+<li>commonFileName</li>
+<li>mimeType</li>
+<li>commonFileType</li>
+<li>commonFileExt</li>
+<li>fileType</li>
+<li>fileExt</li>
+<li>directoryPath</li>
+<li>filePath</li>
+<li>semver</li>
</ul>
-<h2>Localization</h2><p>As of version <code>v2.0.0</code> faker.js supports over 27 different language definition packs.</p>
-<p>The default language is set to English.</p>
+</li>
+</ul>
+<h2>Localization</h2><p>As of version <code>v2.0.0</code> faker.js has support for multiple localities.</p>
+<p>The default language locale is set to English.</p>
<p>Setting a new locale is simple:</p>
<pre class="prettyprint source lang-js"><code>// sets locale to de
faker.locale = &quot;de&quot;;</code></pre><ul>
<li>de</li>
<li>de_AT</li>
<li>de_CH</li>
-<li>el_GR</li>
<li>en</li>
<li>en_AU</li>
<li>en_BORK</li>
@@ -291,6 +312,7 @@ faker.locale = &quot;de&quot;;</code></pre><ul>
<li>fr</li>
<li>fr_CA</li>
<li>ge</li>
+<li>id_ID</li>
<li>it</li>
<li>ja</li>
<li>ko</li>
@@ -319,11 +341,12 @@ See: https://github.com/pateketrueke/json-schema-faker/</p>
<h3>CLI</h3><p>Run faker generators from Command Line.
See: https://github.com/lestoni/faker-cli</p>
<p><strong>Want to see your project added here? Let us know!</strong></p>
-<h3>Meteor</h3><h4>Meteor installation</h4><pre class="prettyprint source"><code> meteor add practicalmeteor:faker</code></pre><h4>meteor usage, both client and server</h4><pre class="prettyprint source"><code> var randomName = faker.name.findName(); // Rowan Nikolaus
- var randomEmail = faker.internet.email(); // [email protected]
- var randomCard = faker.helpers.createCard(); // random contact card containing many properties</code></pre><h2>Version Release Schedule</h2><p>faker.js is a popular project used by many organizations and individuals in production settings. Major and Minor version releases are generally on a monthly schedule. Bugs fixes are addressed by severity and fixed as soon as possible.</p>
+<h3>Meteor</h3><h4>Meteor Installation</h4><pre class="prettyprint source"><code>meteor add practicalmeteor:faker</code></pre><h4>Meteor Usage, both client and server</h4><pre class="prettyprint source lang-js"><code>var randomName = faker.name.findName(); // Rowan Nikolaus
+var randomEmail = faker.internet.email(); // [email protected]
+var randomCard = faker.helpers.createCard(); // random contact card containing many properties</code></pre><h2>Building faker.js</h2><p>faker uses <a href="http://gulpjs.com/">gulp</a> to automate it's build process. Running the following build command will generate new browser builds, documentation, and code examples for the project.</p>
+<pre class="prettyprint source"><code>npm run-script build</code></pre><h2>Building JSDocs</h2><pre class="prettyprint source"><code>npm run-script doc</code></pre><h2>Version Release Schedule</h2><p>faker.js is a popular project used by many organizations and individuals in production settings. Major and Minor version releases are generally on a monthly schedule. Bugs fixes are addressed by severity and fixed as soon as possible.</p>
<p>If you require the absolute latest version of <code>faker.js</code> the <code>master</code> branch @ http://github.com/marak/faker.js/ should always be up to date and working.</p>
-<h2>Authors</h2><h4>Matthew Bergman &amp; Marak Squires</h4><p>faker.js - Copyright (c) 2014-2015
+<h2>Maintainer</h2><h4>Marak Squires</h4><p>faker.js - Copyright (c) 2016
Matthew Bergman &amp; Marak Squires
http://github.com/marak/faker.js/</p>
<p>faker.js was inspired by and has used data definitions from:</p>
@@ -390,7 +413,7 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p></article>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/namespaces.list.html b/doc/namespaces.list.html
index 82562e94..2f6d2f8d 100644
--- a/doc/namespaces.list.html
+++ b/doc/namespaces.list.html
@@ -233,7 +233,7 @@
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
- on 2016-03-03T04:33:18-05:00
+ on 2016-03-20T21:12:53-04:00
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
diff --git a/doc/quicksearch.html b/doc/quicksearch.html
index 26797c4a..d64456ab 100644
--- a/doc/quicksearch.html
+++ b/doc/quicksearch.html
@@ -7,7 +7,7 @@
<script src="scripts/fulltext-search.js"></script>
<script type="text/x-docstrap-searchdb">
- {"namespaces.list.html":{"id":"namespaces.list.html","title":"Namespaces","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespaces Namespaces faker address commerce company date finance hacker helpers image internet lorem name phone random system × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system faker.js - generate massive amounts of fake data in the browser and node.js Demohttp://marak.com/faker.js/ Hosted API Microservicehttp://faker.hook.io Supports all Faker API Methods Full-Featured Microservice Hosted by hook.io curl http://faker.hook.io?property=name.findName&amp;locale=deUsageBrowser&lt;script src = &quot;faker.js&quot; type = &quot;text/javascript&quot;&gt;&lt;/script&gt; &lt;script&gt; var randomName = faker.name.findName(); // Caitlyn Kerluke var randomEmail = faker.internet.email(); // [email protected] var randomCard = faker.helpers.createCard(); // random contact card containing many properties &lt;/script&gt;Node.jsvar faker = require('faker'); var randomName = faker.name.findName(); // Rowan Nikolaus var randomEmail = faker.internet.email(); // [email protected] var randomCard = faker.helpers.createCard(); // random contact card containing many propertiesAPIFaker.fake()As of version v3.0.0 faker.js contains a super useful generator method Faker.fake for combining faker API methods using a mustache string format. Example: console.log(faker.fake('{{name.lastName}}, {{name.firstName}} {{name.suffix}}')); // outputs: &quot;Marks, Dean Sr.&quot;This will interpolate the format string with the value of methods name.lastName(), name.firstName(), and name.suffix() API MethodsA documentation can be generated with npm run-script doc. The docs are put into ./doc. Here is an overview of all api methods: address zipCode city cityPrefix citySuffix streetName streetAddress streetSuffix streetPrefix secondaryAddress county country countryCode state stateAbbr latitude longitude commerce color department productName price productAdjective productMaterial product company suffixes companyName companySuffix catchPhrase bs catchPhraseAdjective catchPhraseDescriptor catchPhraseNoun bsAdjective bsBuzz bsNoun date past future between recent month weekday fake finance account accountName mask amount transactionType currencyCode currencyName currencySymbol hacker abbreviation adjective noun verb ingverb phrase helpers randomize slugify replaceSymbolWithNumber replaceSymbols shuffle mustache createCard contextualCard userCard createTransaction image image avatar imageUrl abstract animals business cats city food nightlife fashion people nature sports technics transport internet avatar email userName protocol url domainName domainSuffix domainWord ip userAgent color mac password lorem words sentence sentences paragraph paragraphs name firstName lastName findName jobTitle prefix suffix title jobDescriptor jobArea jobType phone phoneNumber phoneNumberFormat phoneFormats random number arrayElement objectElement uuid boolean LocalizationAs of version v2.0.0 faker.js supports over 27 different language definition packs. The default language is set to English. Setting a new locale is simple: // sets locale to de faker.locale = &quot;de&quot;; de de_AT de_CH el_GR en en_AU en_BORK en_CA en_GB en_IE en_IND en_US en_au_ocker es es_MX fa fr fr_CA ge it ja ko nb_NO nep nl pl pt_BR ru sk sv tr uk vi zh_CN zh_TW Individual Localization PackagesAs of vesion v3.0.0 faker.js supports incremental loading of locales. By default, requiring faker will include all locale data. In a production environment, you may only want to include the locale data for a specific set of locales. // loads only de locale var faker = require('faker/locale/de');Testsnpm install . make testYou can view a code coverage report generated in coverage/lcov-report/index.html. Projects Built with faker.jsFake JSON SchemaUse faker generators to populate JSON Schema samples. See: https://github.com/pateketrueke/json-schema-faker/ CLIRun faker generators from Command Line. See: https://github.com/lestoni/faker-cli Want to see your project added here? Let us know! MeteorMeteor installation meteor add practicalmeteor:fakermeteor usage, both client and server var randomName = faker.name.findName(); // Rowan Nikolaus var randomEmail = faker.internet.email(); // [email protected] var randomCard = faker.helpers.createCard(); // random contact card containing many propertiesVersion Release Schedulefaker.js is a popular project used by many organizations and individuals in production settings. Major and Minor version releases are generally on a monthly schedule. Bugs fixes are addressed by severity and fixed as soon as possible. If you require the absolute latest version of faker.js the master branch @ http://github.com/marak/faker.js/ should always be up to date and working. AuthorsMatthew Bergman &amp; Marak Squiresfaker.js - Copyright (c) 2014-2015 Matthew Bergman &amp; Marak Squires http://github.com/marak/faker.js/ faker.js was inspired by and has used data definitions from: https://github.com/stympy/faker/ - Copyright (c) 2007-2010 Benjamin Curtis http://search.cpan.org/~jasonk/Data-Faker-0.07/ - Copyright 2004-2005 by Jason Kohles Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the &quot;Software&quot;), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.html":{"id":"faker.html","title":"Namespace: faker","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: faker faker Namespaces address commerce company date finance hacker helpers image internet lorem name phone random system Methods &lt;static&gt; fake(str) Generator method for combining faker methods based on string input Example: console.log(faker.fake('{{name.lastName}}, {{name.firstName}} {{name.suffix}}')); //outputs: &quot;Marks, Dean Sr.&quot;This will interpolate the format string with the value of methods name.lastName, name.firstName, and name.suffix Parameters: Name Type Description str string × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.address.html":{"id":"faker.address.html","title":"Namespace: address","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: address faker. address Methods &lt;static&gt; city(format) Generates a random localized city name. The format string can contain any method provided by faker wrapped in {{}}, e.g. {{name.firstName}} in order to build the city name. If no format string is provided one of the following is randomly used: {{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}} {{address.cityPrefix}} {{name.firstName}} {{name.firstName}}{{address.citySuffix}} {{name.lastName}}{{address.citySuffix}} Parameters: Name Type Description format String &lt;static&gt; cityPrefix() Return a random localized city prefix &lt;static&gt; citySuffix() Return a random localized city suffix &lt;static&gt; country() country &lt;static&gt; countryCode() countryCode &lt;static&gt; county() county &lt;static&gt; latitude() latitude &lt;static&gt; longitude() longitude &lt;static&gt; secondaryAddress() secondaryAddress &lt;static&gt; state(useAbbr) state Parameters: Name Type Description useAbbr Boolean &lt;static&gt; stateAbbr() stateAbbr &lt;static&gt; streetAddress(useFullAddress) Returns a random localized street address Parameters: Name Type Description useFullAddress Boolean &lt;static&gt; streetName() Returns a random localized street name &lt;static&gt; streetPrefix() streetPrefix &lt;static&gt; streetSuffix() streetSuffix &lt;static&gt; zipCode(format) Generates random zipcode from format. If format is not specified, the locale's zip format is used. Parameters: Name Type Description format String × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.commerce.html":{"id":"faker.commerce.html","title":"Namespace: commerce","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: commerce faker. commerce Methods &lt;static&gt; color() color &lt;static&gt; department(max, fixedAmount) department Parameters: Name Type Description max number fixedAmount number &lt;static&gt; price(min, max, dec, symbol) price Parameters: Name Type Description min number max number dec number symbol string &lt;static&gt; product() product &lt;static&gt; productAdjective() productAdjective &lt;static&gt; productMaterial() productMaterial &lt;static&gt; productName() productName × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.company.html":{"id":"faker.company.html","title":"Namespace: company","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: company faker. company Methods &lt;static&gt; bs() bs &lt;static&gt; bsAdjective() bsAdjective &lt;static&gt; bsBuzz() bsBuzz &lt;static&gt; bsNoun() bsNoun &lt;static&gt; catchPhrase() catchPhrase &lt;static&gt; catchPhraseAdjective() catchPhraseAdjective &lt;static&gt; catchPhraseDescriptor() catchPhraseDescriptor &lt;static&gt; catchPhraseNoun() catchPhraseNoun &lt;static&gt; companyName(format) companyName Parameters: Name Type Description format string &lt;static&gt; companySuffix() companySuffix &lt;static&gt; suffixes() suffixes × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.date.html":{"id":"faker.date.html","title":"Namespace: date","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: date faker. date Methods &lt;static&gt; between(from, to) between Parameters: Name Type Description from date to date &lt;static&gt; future(years, refDate) future Parameters: Name Type Description years number refDate date &lt;static&gt; month(options) month Parameters: Name Type Description options object &lt;static&gt; past(years, refDate) past Parameters: Name Type Description years number refDate date &lt;static&gt; recent(days) recent Parameters: Name Type Description days number &lt;static&gt; weekday(options) weekday Parameters: Name Type Description options object × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.finance.html":{"id":"faker.finance.html","title":"Namespace: finance","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: finance faker. finance Methods &lt;static&gt; account(length) account Parameters: Name Type Description length number &lt;static&gt; accountName() accountName &lt;static&gt; amount(min, max, dec, symbol) amount Parameters: Name Type Description min number max number dec number symbol string &lt;static&gt; currencyCode() currencyCode &lt;static&gt; currencyName() currencyName &lt;static&gt; currencySymbol() currencySymbol &lt;static&gt; mask(length, parens, elipsis) mask Parameters: Name Type Description length number parens boolean elipsis boolean &lt;static&gt; transactionType() transactionType × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.hacker.html":{"id":"faker.hacker.html","title":"Namespace: hacker","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: hacker faker. hacker Methods &lt;static&gt; abbreviation() abbreviation &lt;static&gt; adjective() adjective &lt;static&gt; ingverb() ingverb &lt;static&gt; noun() noun &lt;static&gt; phrase() phrase &lt;static&gt; verb() verb × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.helpers.html":{"id":"faker.helpers.html","title":"Namespace: helpers","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: helpers faker. helpers Methods &lt;static&gt; contextualCard() contextualCard &lt;static&gt; createCard() createCard &lt;static&gt; createTransaction() createTransaction &lt;static&gt; mustache(str, data) mustache Parameters: Name Type Description str string data object &lt;static&gt; randomize(array) backword-compatibility Parameters: Name Type Description array array &lt;static&gt; replaceSymbols(string) parses string for symbols (numbers or letters) and replaces them appropriately Parameters: Name Type Description string string &lt;static&gt; replaceSymbolWithNumber(string, symbol) parses string for a symbol and replace it with a random number from 1-10 Parameters: Name Type Description string string symbol string defaults to &quot;#&quot; &lt;static&gt; shuffle(o) takes an array and returns it randomized Parameters: Name Type Description o array &lt;static&gt; slugify(string) slugifies string Parameters: Name Type Description string string &lt;static&gt; userCard() userCard × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.image.html":{"id":"faker.image.html","title":"Namespace: image","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: image faker. image Methods &lt;static&gt; abstract(width, height, randomize) abstract Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; animals(width, height, randomize) animals Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; avatar() avatar &lt;static&gt; business(width, height, randomize) business Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; cats(width, height, randomize) cats Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; city(width, height, randomize) city Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; fashion(width, height, randomize) fashion Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; food(width, height, randomize) food Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; image(width, height, randomize) image Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; imageUrl(width, height, category, randomize) imageUrl Parameters: Name Type Description width number height number category string randomize boolean &lt;static&gt; nature(width, height, randomize) nature Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; nightlife(width, height, randomize) nightlife Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; people(width, height, randomize) people Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; sports(width, height, randomize) sports Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; technics(width, height, randomize) technics Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; transport(width, height, randomize) transport Parameters: Name Type Description width number height number randomize boolean × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.internet.html":{"id":"faker.internet.html","title":"Namespace: internet","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: internet faker. internet Methods &lt;static&gt; avatar() avatar &lt;static&gt; color(baseRed255, baseGreen255, baseBlue255) color Parameters: Name Type Description baseRed255 number baseGreen255 number baseBlue255 number &lt;static&gt; domainName() domainName &lt;static&gt; domainSuffix() domainSuffix &lt;static&gt; domainWord() domainWord &lt;static&gt; email(firstName, lastName, provider) email Parameters: Name Type Description firstName string lastName string provider string &lt;static&gt; exampleEmail(firstName, lastName) exampleEmail Parameters: Name Type Description firstName string lastName string &lt;static&gt; ip() ip &lt;static&gt; mac() mac &lt;static&gt; password(len, memorable, pattern, prefix) password Parameters: Name Type Description len number memorable boolean pattern string prefix string &lt;static&gt; protocol() protocol &lt;static&gt; url() url &lt;static&gt; userAgent() userAgent &lt;static&gt; userName(firstName, lastName) userName Parameters: Name Type Description firstName string lastName string × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.lorem.html":{"id":"faker.lorem.html","title":"Namespace: lorem","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: lorem faker. lorem Methods &lt;static&gt; lines(lineCount) returns lines of lorem separated by '\\n' Parameters: Name Type Description lineCount number defaults to a random number between 1 and 5 &lt;static&gt; paragraph(sentenceCount) paragraph Parameters: Name Type Description sentenceCount number defaults to 3 &lt;static&gt; paragraphs(paragraphCount, separatora) paragraphs Parameters: Name Type Description paragraphCount number defaults to 3 separatora string defaults to '\\n \\r' &lt;static&gt; sentence(wordCount, range) sentence Parameters: Name Type Description wordCount number defaults to a random number between 3 and 10 range number &lt;static&gt; sentences(sentenceCount, separator) sentences Parameters: Name Type Description sentenceCount number defautls to a random number between 2 and 6 separator string defaults to ' ' &lt;static&gt; text(times) returns random text based on a random lorem method Parameters: Name Type Description times number &lt;static&gt; word(num) word Parameters: Name Type Description num number &lt;static&gt; words(num) generates a space separated list of words Parameters: Name Type Description num number number of words, defaults to 3 × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.name.html":{"id":"faker.name.html","title":"Namespace: name","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: name faker. name Methods &lt;static&gt; findName(firstName, lastName, gender) findName Parameters: Name Type Description firstName string lastName string gender mixed &lt;static&gt; firstName(gender) firstName Parameters: Name Type Description gender mixed &lt;static&gt; jobArea() jobArea &lt;static&gt; jobDescriptor() jobDescriptor &lt;static&gt; jobTitle() jobTitle &lt;static&gt; jobType() jobType &lt;static&gt; lastName(gender) lastName Parameters: Name Type Description gender mixed &lt;static&gt; prefix(gender) prefix Parameters: Name Type Description gender mixed &lt;static&gt; suffix() suffix &lt;static&gt; title() title × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.phone.html":{"id":"faker.phone.html","title":"Namespace: phone","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: phone faker. phone Methods &lt;static&gt; phoneFormats() phoneFormats &lt;static&gt; phoneFormatsArrayIndex(phoneFormatsArrayIndex) phoneNumberFormat Parameters: Name Type Description phoneFormatsArrayIndex &lt;static&gt; phoneNumber(format) phoneNumber Parameters: Name Type Description format string × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.random.html":{"id":"faker.random.html","title":"Namespace: random","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: random faker. random Methods &lt;static&gt; arrayElement(array) takes an array and returns a random element of the array Parameters: Name Type Description array array &lt;static&gt; boolean() boolean &lt;static&gt; image() locale &lt;static&gt; locale() locale &lt;static&gt; number(options) returns a single random number based on a max number or range Parameters: Name Type Description options mixed &lt;static&gt; objectElement(object, field) takes an object and returns the randomly key or value Parameters: Name Type Description object object field mixed &lt;static&gt; uuid() uuid &lt;static&gt; word(type) word Parameters: Name Type Description type string &lt;static&gt; words(count) randomWords Parameters: Name Type Description count number defaults to a random value between 1 and 3 × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "},"faker.system.html":{"id":"faker.system.html","title":"Namespace: system","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: system faker. system Methods &lt;static&gt; commonFileExt(type) returns a commonly used file extension based on optional type Parameters: Name Type Description type string &lt;static&gt; commonFileName(ext, type) commonFileName Parameters: Name Type Description ext string type string &lt;static&gt; commonFileType() returns a commonly used file type &lt;static&gt; directoryPath() not yet implemented &lt;static&gt; fileExt(mimeType) fileExt Parameters: Name Type Description mimeType string &lt;static&gt; fileName(ext, type) generates a file name with extension or optional type Parameters: Name Type Description ext string type string &lt;static&gt; filePath() not yet implemented &lt;static&gt; fileType() returns any file type available as mime-type &lt;static&gt; mimeType() mimeType &lt;static&gt; semver() semver × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-03T04:33:18-05:00 using the DocStrap template. "}}
+ {"namespaces.list.html":{"id":"namespaces.list.html","title":"Namespaces","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespaces Namespaces faker address commerce company date finance hacker helpers image internet lorem name phone random system × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system faker.js - generate massive amounts of fake data in the browser and node.js Demohttp://marak.com/faker.js/ Hosted API Microservicehttp://faker.hook.io Supports all Faker API Methods Full-Featured Microservice Hosted by hook.io curl http://faker.hook.io?property=name.findName&amp;locale=deUsageBrowser&lt;script src = &quot;faker.js&quot; type = &quot;text/javascript&quot;&gt;&lt;/script&gt; &lt;script&gt; var randomName = faker.name.findName(); // Caitlyn Kerluke var randomEmail = faker.internet.email(); // [email protected] var randomCard = faker.helpers.createCard(); // random contact card containing many properties &lt;/script&gt;Node.jsvar faker = require('faker'); var randomName = faker.name.findName(); // Rowan Nikolaus var randomEmail = faker.internet.email(); // [email protected] var randomCard = faker.helpers.createCard(); // random contact card containing many propertiesAPIFaker.fake()faker.js contains a super useful generator method Faker.fake for combining faker API methods using a mustache string format. Example: console.log(faker.fake(&quot;{{name.lastName}}, {{name.firstName}} {{name.suffix}}&quot;)); // outputs: &quot;Marks, Dean Sr.&quot;This will interpolate the format string with the value of methods name.lastName(), name.firstName(), and name.suffix() JSDoc API Browserhttp://marak.github.io/faker.js/ API Methods address zipCode city cityPrefix citySuffix streetName streetAddress streetSuffix streetPrefix secondaryAddress county country countryCode state stateAbbr latitude longitude commerce color department productName price productAdjective productMaterial product company suffixes companyName companySuffix catchPhrase bs catchPhraseAdjective catchPhraseDescriptor catchPhraseNoun bsAdjective bsBuzz bsNoun date past future between recent month weekday fake finance account accountName mask amount transactionType currencyCode currencyName currencySymbol bitcoinAddress hacker abbreviation adjective noun verb ingverb phrase helpers randomize slugify replaceSymbolWithNumber replaceSymbols shuffle mustache createCard contextualCard userCard createTransaction image image avatar imageUrl abstract animals business cats city food nightlife fashion people nature sports technics transport internet avatar email exampleEmail userName protocol url domainName domainSuffix domainWord ip userAgent color mac password lorem word words sentence sentences paragraph paragraphs text lines name firstName lastName findName jobTitle prefix suffix title jobDescriptor jobArea jobType phone phoneNumber phoneNumberFormat phoneFormats random number arrayElement objectElement uuid boolean word words image locale alphaNumeric system fileName commonFileName mimeType commonFileType commonFileExt fileType fileExt directoryPath filePath semver LocalizationAs of version v2.0.0 faker.js has support for multiple localities. The default language locale is set to English. Setting a new locale is simple: // sets locale to de faker.locale = &quot;de&quot;; de de_AT de_CH en en_AU en_BORK en_CA en_GB en_IE en_IND en_US en_au_ocker es es_MX fa fr fr_CA ge id_ID it ja ko nb_NO nep nl pl pt_BR ru sk sv tr uk vi zh_CN zh_TW Individual Localization PackagesAs of vesion v3.0.0 faker.js supports incremental loading of locales. By default, requiring faker will include all locale data. In a production environment, you may only want to include the locale data for a specific set of locales. // loads only de locale var faker = require('faker/locale/de');Testsnpm install . make testYou can view a code coverage report generated in coverage/lcov-report/index.html. Projects Built with faker.jsFake JSON SchemaUse faker generators to populate JSON Schema samples. See: https://github.com/pateketrueke/json-schema-faker/ CLIRun faker generators from Command Line. See: https://github.com/lestoni/faker-cli Want to see your project added here? Let us know! MeteorMeteor Installationmeteor add practicalmeteor:fakerMeteor Usage, both client and servervar randomName = faker.name.findName(); // Rowan Nikolaus var randomEmail = faker.internet.email(); // [email protected] var randomCard = faker.helpers.createCard(); // random contact card containing many propertiesBuilding faker.jsfaker uses gulp to automate it's build process. Running the following build command will generate new browser builds, documentation, and code examples for the project. npm run-script buildBuilding JSDocsnpm run-script docVersion Release Schedulefaker.js is a popular project used by many organizations and individuals in production settings. Major and Minor version releases are generally on a monthly schedule. Bugs fixes are addressed by severity and fixed as soon as possible. If you require the absolute latest version of faker.js the master branch @ http://github.com/marak/faker.js/ should always be up to date and working. MaintainerMarak Squiresfaker.js - Copyright (c) 2016 Matthew Bergman &amp; Marak Squires http://github.com/marak/faker.js/ faker.js was inspired by and has used data definitions from: https://github.com/stympy/faker/ - Copyright (c) 2007-2010 Benjamin Curtis http://search.cpan.org/~jasonk/Data-Faker-0.07/ - Copyright 2004-2005 by Jason Kohles Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the &quot;Software&quot;), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.html":{"id":"faker.html","title":"Namespace: faker","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: faker faker Namespaces address commerce company date finance hacker helpers image internet lorem name phone random system Methods &lt;static&gt; fake(str) Generator method for combining faker methods based on string input Example: console.log(faker.fake('{{name.lastName}}, {{name.firstName}} {{name.suffix}}')); //outputs: &quot;Marks, Dean Sr.&quot;This will interpolate the format string with the value of methods name.lastName, name.firstName, and name.suffix Parameters: Name Type Description str string × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.address.html":{"id":"faker.address.html","title":"Namespace: address","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: address faker. address Methods &lt;static&gt; city(format) Generates a random localized city name. The format string can contain any method provided by faker wrapped in {{}}, e.g. {{name.firstName}} in order to build the city name. If no format string is provided one of the following is randomly used: {{address.cityPrefix}} {{name.firstName}}{{address.citySuffix}} {{address.cityPrefix}} {{name.firstName}} {{name.firstName}}{{address.citySuffix}} {{name.lastName}}{{address.citySuffix}} Parameters: Name Type Description format String &lt;static&gt; cityPrefix() Return a random localized city prefix &lt;static&gt; citySuffix() Return a random localized city suffix &lt;static&gt; country() country &lt;static&gt; countryCode() countryCode &lt;static&gt; county() county &lt;static&gt; latitude() latitude &lt;static&gt; longitude() longitude &lt;static&gt; secondaryAddress() secondaryAddress &lt;static&gt; state(useAbbr) state Parameters: Name Type Description useAbbr Boolean &lt;static&gt; stateAbbr() stateAbbr &lt;static&gt; streetAddress(useFullAddress) Returns a random localized street address Parameters: Name Type Description useFullAddress Boolean &lt;static&gt; streetName() Returns a random localized street name &lt;static&gt; streetPrefix() streetPrefix &lt;static&gt; streetSuffix() streetSuffix &lt;static&gt; zipCode(format) Generates random zipcode from format. If format is not specified, the locale's zip format is used. Parameters: Name Type Description format String × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.commerce.html":{"id":"faker.commerce.html","title":"Namespace: commerce","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: commerce faker. commerce Methods &lt;static&gt; color() color &lt;static&gt; department(max, fixedAmount) department Parameters: Name Type Description max number fixedAmount number &lt;static&gt; price(min, max, dec, symbol) price Parameters: Name Type Description min number max number dec number symbol string &lt;static&gt; product() product &lt;static&gt; productAdjective() productAdjective &lt;static&gt; productMaterial() productMaterial &lt;static&gt; productName() productName × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.company.html":{"id":"faker.company.html","title":"Namespace: company","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: company faker. company Methods &lt;static&gt; bs() bs &lt;static&gt; bsAdjective() bsAdjective &lt;static&gt; bsBuzz() bsBuzz &lt;static&gt; bsNoun() bsNoun &lt;static&gt; catchPhrase() catchPhrase &lt;static&gt; catchPhraseAdjective() catchPhraseAdjective &lt;static&gt; catchPhraseDescriptor() catchPhraseDescriptor &lt;static&gt; catchPhraseNoun() catchPhraseNoun &lt;static&gt; companyName(format) companyName Parameters: Name Type Description format string &lt;static&gt; companySuffix() companySuffix &lt;static&gt; suffixes() suffixes × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.date.html":{"id":"faker.date.html","title":"Namespace: date","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: date faker. date Methods &lt;static&gt; between(from, to) between Parameters: Name Type Description from date to date &lt;static&gt; future(years, refDate) future Parameters: Name Type Description years number refDate date &lt;static&gt; month(options) month Parameters: Name Type Description options object &lt;static&gt; past(years, refDate) past Parameters: Name Type Description years number refDate date &lt;static&gt; recent(days) recent Parameters: Name Type Description days number &lt;static&gt; weekday(options) weekday Parameters: Name Type Description options object × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.finance.html":{"id":"faker.finance.html","title":"Namespace: finance","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: finance faker. finance Methods &lt;static&gt; account(length) account Parameters: Name Type Description length number &lt;static&gt; accountName() accountName &lt;static&gt; amount(min, max, dec, symbol) amount Parameters: Name Type Description min number max number dec number symbol string &lt;static&gt; bitcoinAddress() bitcoinAddress &lt;static&gt; currencyCode() currencyCode &lt;static&gt; currencyName() currencyName &lt;static&gt; currencySymbol() currencySymbol &lt;static&gt; mask(length, parens, elipsis) mask Parameters: Name Type Description length number parens boolean elipsis boolean &lt;static&gt; transactionType() transactionType × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.hacker.html":{"id":"faker.hacker.html","title":"Namespace: hacker","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: hacker faker. hacker Methods &lt;static&gt; abbreviation() abbreviation &lt;static&gt; adjective() adjective &lt;static&gt; ingverb() ingverb &lt;static&gt; noun() noun &lt;static&gt; phrase() phrase &lt;static&gt; verb() verb × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.helpers.html":{"id":"faker.helpers.html","title":"Namespace: helpers","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: helpers faker. helpers Methods &lt;static&gt; contextualCard() contextualCard &lt;static&gt; createCard() createCard &lt;static&gt; createTransaction() createTransaction &lt;static&gt; mustache(str, data) mustache Parameters: Name Type Description str string data object &lt;static&gt; randomize(array) backword-compatibility Parameters: Name Type Description array array &lt;static&gt; replaceSymbols(string) parses string for symbols (numbers or letters) and replaces them appropriately Parameters: Name Type Description string string &lt;static&gt; replaceSymbolWithNumber(string, symbol) parses string for a symbol and replace it with a random number from 1-10 Parameters: Name Type Description string string symbol string defaults to &quot;#&quot; &lt;static&gt; shuffle(o) takes an array and returns it randomized Parameters: Name Type Description o array &lt;static&gt; slugify(string) slugifies string Parameters: Name Type Description string string &lt;static&gt; userCard() userCard × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.image.html":{"id":"faker.image.html","title":"Namespace: image","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: image faker. image Methods &lt;static&gt; abstract(width, height, randomize) abstract Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; animals(width, height, randomize) animals Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; avatar() avatar &lt;static&gt; business(width, height, randomize) business Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; cats(width, height, randomize) cats Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; city(width, height, randomize) city Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; fashion(width, height, randomize) fashion Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; food(width, height, randomize) food Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; image(width, height, randomize) image Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; imageUrl(width, height, category, randomize) imageUrl Parameters: Name Type Description width number height number category string randomize boolean &lt;static&gt; nature(width, height, randomize) nature Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; nightlife(width, height, randomize) nightlife Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; people(width, height, randomize) people Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; sports(width, height, randomize) sports Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; technics(width, height, randomize) technics Parameters: Name Type Description width number height number randomize boolean &lt;static&gt; transport(width, height, randomize) transport Parameters: Name Type Description width number height number randomize boolean × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.internet.html":{"id":"faker.internet.html","title":"Namespace: internet","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: internet faker. internet Methods &lt;static&gt; avatar() avatar &lt;static&gt; color(baseRed255, baseGreen255, baseBlue255) color Parameters: Name Type Description baseRed255 number baseGreen255 number baseBlue255 number &lt;static&gt; domainName() domainName &lt;static&gt; domainSuffix() domainSuffix &lt;static&gt; domainWord() domainWord &lt;static&gt; email(firstName, lastName, provider) email Parameters: Name Type Description firstName string lastName string provider string &lt;static&gt; exampleEmail(firstName, lastName) exampleEmail Parameters: Name Type Description firstName string lastName string &lt;static&gt; ip() ip &lt;static&gt; mac() mac &lt;static&gt; password(len, memorable, pattern, prefix) password Parameters: Name Type Description len number memorable boolean pattern string prefix string &lt;static&gt; protocol() protocol &lt;static&gt; url() url &lt;static&gt; userAgent() userAgent &lt;static&gt; userName(firstName, lastName) userName Parameters: Name Type Description firstName string lastName string × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.lorem.html":{"id":"faker.lorem.html","title":"Namespace: lorem","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: lorem faker. lorem Methods &lt;static&gt; lines(lineCount) returns lines of lorem separated by '\\n' Parameters: Name Type Description lineCount number defaults to a random number between 1 and 5 &lt;static&gt; paragraph(sentenceCount) paragraph Parameters: Name Type Description sentenceCount number defaults to 3 &lt;static&gt; paragraphs(paragraphCount, separatora) paragraphs Parameters: Name Type Description paragraphCount number defaults to 3 separatora string defaults to '\\n \\r' &lt;static&gt; sentence(wordCount, range) sentence Parameters: Name Type Description wordCount number defaults to a random number between 3 and 10 range number &lt;static&gt; sentences(sentenceCount, separator) sentences Parameters: Name Type Description sentenceCount number defautls to a random number between 2 and 6 separator string defaults to ' ' &lt;static&gt; text(times) returns random text based on a random lorem method Parameters: Name Type Description times number &lt;static&gt; word(num) word Parameters: Name Type Description num number &lt;static&gt; words(num) generates a space separated list of words Parameters: Name Type Description num number number of words, defaults to 3 × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.name.html":{"id":"faker.name.html","title":"Namespace: name","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: name faker. name Methods &lt;static&gt; findName(firstName, lastName, gender) findName Parameters: Name Type Description firstName string lastName string gender mixed &lt;static&gt; firstName(gender) firstName Parameters: Name Type Description gender mixed &lt;static&gt; jobArea() jobArea &lt;static&gt; jobDescriptor() jobDescriptor &lt;static&gt; jobTitle() jobTitle &lt;static&gt; jobType() jobType &lt;static&gt; lastName(gender) lastName Parameters: Name Type Description gender mixed &lt;static&gt; prefix(gender) prefix Parameters: Name Type Description gender mixed &lt;static&gt; suffix() suffix &lt;static&gt; title() title × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.phone.html":{"id":"faker.phone.html","title":"Namespace: phone","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: phone faker. phone Methods &lt;static&gt; phoneFormats() phoneFormats &lt;static&gt; phoneFormatsArrayIndex(phoneFormatsArrayIndex) phoneNumberFormat Parameters: Name Type Description phoneFormatsArrayIndex &lt;static&gt; phoneNumber(format) phoneNumber Parameters: Name Type Description format string × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.random.html":{"id":"faker.random.html","title":"Namespace: random","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: random faker. random Methods &lt;static&gt; alphaNumeric() alphaNumeric &lt;static&gt; arrayElement(array) takes an array and returns a random element of the array Parameters: Name Type Description array array &lt;static&gt; boolean() boolean &lt;static&gt; image() locale &lt;static&gt; locale() locale &lt;static&gt; number(options) returns a single random number based on a max number or range Parameters: Name Type Description options mixed &lt;static&gt; objectElement(object, field) takes an object and returns the randomly key or value Parameters: Name Type Description object object field mixed &lt;static&gt; uuid() uuid &lt;static&gt; word(type) word Parameters: Name Type Description type string &lt;static&gt; words(count) randomWords Parameters: Name Type Description count number defaults to a random value between 1 and 3 × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "},"faker.system.html":{"id":"faker.system.html","title":"Namespace: system","body":" Documentation Namespaces fakerfaker.addressfaker.commercefaker.companyfaker.datefaker.financefaker.hackerfaker.helpersfaker.imagefaker.internetfaker.loremfaker.namefaker.phonefaker.randomfaker.system Namespace: system faker. system Methods &lt;static&gt; commonFileExt(type) returns a commonly used file extension based on optional type Parameters: Name Type Description type string &lt;static&gt; commonFileName(ext, type) commonFileName Parameters: Name Type Description ext string type string &lt;static&gt; commonFileType() returns a commonly used file type &lt;static&gt; directoryPath() not yet implemented &lt;static&gt; fileExt(mimeType) fileExt Parameters: Name Type Description mimeType string &lt;static&gt; fileName(ext, type) generates a file name with extension or optional type Parameters: Name Type Description ext string type string &lt;static&gt; filePath() not yet implemented &lt;static&gt; fileType() returns any file type available as mime-type &lt;static&gt; mimeType() mimeType &lt;static&gt; semver() semver × Search results Close Documentation generated by JSDoc 3.4.0 on 2016-03-20T21:12:53-04:00 using the DocStrap template. "}}
</script>
<script type="text/javascript">