diff options
| author | Marak <[email protected]> | 2021-02-11 01:24:16 -0500 |
|---|---|---|
| committer | GitHub <[email protected]> | 2021-02-11 01:24:16 -0500 |
| commit | 9c8b3249ffa8412d305bea0522d5754f88f000ae (patch) | |
| tree | 665bb0c281ea8a170e5c8da414aed1b80e75d86b /doc/faker.lorem.html | |
| parent | 00f18703af6bf46b0435f4cc9ed1838054a79c1c (diff) | |
| parent | 388b6cd8513b3b73daab5278e539f8f6bb600e12 (diff) | |
| download | faker-9c8b3249ffa8412d305bea0522d5754f88f000ae.tar.xz faker-9c8b3249ffa8412d305bea0522d5754f88f000ae.zip | |
Merge branch 'master' into master
Diffstat (limited to 'doc/faker.lorem.html')
| -rw-r--r-- | doc/faker.lorem.html | 3852 |
1 files changed, 3815 insertions, 37 deletions
diff --git a/doc/faker.lorem.html b/doc/faker.lorem.html index 7801ce62..b65277fe 100644 --- a/doc/faker.lorem.html +++ b/doc/faker.lorem.html @@ -33,21 +33,30 @@ <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> + <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.git.html">faker.git</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.image.lorempicsum.html">faker.image.lorempicsum</a></li><li><a href="faker.image.lorempixel.html">faker.image.lorempixel</a></li><li><a href="faker.image.unsplash.html">faker.image.unsplash</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.music.html">faker.music</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><li><a href="faker.time.html">faker.time</a></li><li><a href="faker.unique.html">faker.unique</a></li><li><a href="faker.vehicle.html">faker.vehicle</a></li> + </ul> + </li> + + <li class="dropdown"> + <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a> + <ul class="dropdown-menu "> + <li><a href="global.html#unique">unique</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 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> - </div> - </form> - </div> + </form> + </div> + </div> </div> @@ -274,6 +283,262 @@ <hr> <dt> + <h4 class="name" id=".lines"><span class="type-signature"><static> </span>lines(lineCount)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>returns lines of lorem separated by <code>'\n'</code></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>lineCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to a random number between 1 and 5</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".paragraph"><span class="type-signature"><static> </span>paragraph(sentenceCount)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>paragraph</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>sentenceCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to 3</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> <h4 class="name" id=".paragraph"><span class="type-signature"><static> </span>paragraph(sentenceCount)</h4> @@ -554,6 +819,310 @@ <hr> <dt> + <h4 class="name" id=".paragraphs"><span class="type-signature"><static> </span>paragraphs(paragraphCount, separator)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>paragraphs</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>paragraphCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to 3</p></td> + </tr> + + + + <tr> + + <td class="name"><code>separator</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to <code>'\n \r'</code></p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".sentence"><span class="type-signature"><static> </span>sentence(wordCount, range)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>sentence</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>wordCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to a random number between 3 and 10</p></td> + </tr> + + + + <tr> + + <td class="name"><code>range</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> <h4 class="name" id=".sentence"><span class="type-signature"><static> </span>sentence(wordCount, range)</h4> @@ -858,6 +1427,286 @@ <hr> <dt> + <h4 class="name" id=".sentences"><span class="type-signature"><static> </span>sentences(sentenceCount, separator)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>sentences</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>sentenceCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defautls to a random number between 2 and 6</p></td> + </tr> + + + + <tr> + + <td class="name"><code>separator</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to <code>' '</code></p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".slug"><span class="type-signature"><static> </span>slug(wordCount)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>slug</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>wordCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>number of words, defaults to 3</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> <h4 class="name" id=".slug"><span class="type-signature"><static> </span>slug(wordCount)</h4> @@ -1114,7 +1963,7 @@ <hr> <dt> - <h4 class="name" id=".word"><span class="type-signature"><static> </span>word(num)</h4> + <h4 class="name" id=".text"><span class="type-signature"><static> </span>text(times)</h4> </dt> @@ -1122,7 +1971,391 @@ <div class="description"> - <p>word</p> + <p>returns random text based on a random lorem method</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>times</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".word"><span class="type-signature"><static> </span>word(length)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>generates a word of a specified length</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>length</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>length of the word that should be returned. Defaults to a random length</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".word"><span class="type-signature"><static> </span>word(length)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>generates a word of a specified length</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>length</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>length of the word that should be returned. Defaults to a random length</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".words"><span class="type-signature"><static> </span>words(num)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>generates a space separated list of words</p> </div> @@ -1174,6 +2407,1346 @@ + <td class="description last"><p>number of words, defaults to 3</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".words"><span class="type-signature"><static> </span>words(num)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>generates a space separated list of words</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>num</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>number of words, defaults to 3</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + </dl> + + + + + +</article> + +</section> + + + + + <h1 class="page-title">Namespace: lorem</h1> +<section> + +<header> + + <h2> + <span class="ancestors"><a href="faker.html">faker</a>.</span> + + lorem + </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=".lines"><span class="type-signature"><static> </span>lines(lineCount)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>returns lines of lorem separated by <code>'\n'</code></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>lineCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to a random number between 1 and 5</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".lines"><span class="type-signature"><static> </span>lines(lineCount)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>returns lines of lorem separated by <code>'\n'</code></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>lineCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to a random number between 1 and 5</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".paragraph"><span class="type-signature"><static> </span>paragraph(sentenceCount)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>paragraph</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>sentenceCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to 3</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".paragraph"><span class="type-signature"><static> </span>paragraph(sentenceCount)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>paragraph</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>sentenceCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to 3</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".paragraphs"><span class="type-signature"><static> </span>paragraphs(paragraphCount, separator)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>paragraphs</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>paragraphCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to 3</p></td> + </tr> + + + + <tr> + + <td class="name"><code>separator</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to <code>'\n \r'</code></p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".paragraphs"><span class="type-signature"><static> </span>paragraphs(paragraphCount, separator)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>paragraphs</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>paragraphCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to 3</p></td> + </tr> + + + + <tr> + + <td class="name"><code>separator</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to <code>'\n \r'</code></p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".sentence"><span class="type-signature"><static> </span>sentence(wordCount, range)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>sentence</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>wordCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to a random number between 3 and 10</p></td> + </tr> + + + + <tr> + + <td class="name"><code>range</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".sentence"><span class="type-signature"><static> </span>sentence(wordCount, range)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>sentence</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>wordCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to a random number between 3 and 10</p></td> + </tr> + + + + <tr> + + <td class="name"><code>range</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + <td class="description last"></td> </tr> @@ -1242,6 +3815,1206 @@ <hr> <dt> + <h4 class="name" id=".sentences"><span class="type-signature"><static> </span>sentences(sentenceCount, separator)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>sentences</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>sentenceCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defautls to a random number between 2 and 6</p></td> + </tr> + + + + <tr> + + <td class="name"><code>separator</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to <code>' '</code></p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".sentences"><span class="type-signature"><static> </span>sentences(sentenceCount, separator)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>sentences</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>sentenceCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>defautls to a random number between 2 and 6</p></td> + </tr> + + + + <tr> + + <td class="name"><code>separator</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + + </td> + + + + + + <td class="description last"><p>defaults to <code>' '</code></p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".slug"><span class="type-signature"><static> </span>slug(wordCount)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>slug</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>wordCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>number of words, defaults to 3</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".slug"><span class="type-signature"><static> </span>slug(wordCount)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>slug</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>wordCount</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>number of words, defaults to 3</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".text"><span class="type-signature"><static> </span>text(times)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>returns random text based on a random lorem method</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>times</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".text"><span class="type-signature"><static> </span>text(times)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>returns random text based on a random lorem method</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>times</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".word"><span class="type-signature"><static> </span>word(length)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>generates a word of a specified length</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>length</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>length of the word that should be returned. Defaults to a random length</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".word"><span class="type-signature"><static> </span>word(length)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>generates a word of a specified length</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>length</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>length of the word that should be returned. Defaults to a random length</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".words"><span class="type-signature"><static> </span>words(num)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>generates a space separated list of words</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>num</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + + </td> + + + + + + <td class="description last"><p>number of words, defaults to 3</p></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> <h4 class="name" id=".words"><span class="type-signature"><static> </span>words(num)</h4> @@ -1393,28 +5166,30 @@ </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> + + <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> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> - on 2017-02-21T13:01:35-05:00 + on 2021-02-10T14:58:19-05:00 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. </span> @@ -1422,7 +5197,9 @@ <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 type="text/javascript" src="scripts/fulltext-search-ui.js"></script> + <script> $( function () { @@ -1432,7 +5209,7 @@ $( function () { $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) ); } ); - $( ".tutorial-section pre, .readme-section pre" ).each( function () { + $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () { var $this = $( this ); var example = $this.find( "code" ); @@ -1468,8 +5245,7 @@ $( function () { } ); $( "#toc" ).toc( { anchorName : function ( i, heading, prefix ) { - var id = $( heading ).attr( "id" ); - return id && id.replace(/\~/g, '-inner-').replace(/\./g, '-static-') || ( prefix + i ); + return $( heading ).attr( "id" ) || ( prefix + i ); }, selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4", showAndHide : false, @@ -1495,11 +5271,13 @@ $( function () { <!--Google Analytics--> -<script type="text/javascript"> - $(document).ready(function() { - SearcherDisplay.init(); - }); -</script> + + <script type="text/javascript"> + $(document).ready(function() { + SearcherDisplay.init(); + }); + </script> + </body> </html>
\ No newline at end of file |
