Skip to content

chore(docs): fix imports #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 17, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Coming soon!
### Node.js

```js
var faker = require('faker');
var faker = require('@faker-js/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 properties
Expand Down Expand Up @@ -372,7 +372,7 @@ In a production environment, you may only want to include the locale data for a

```js
// loads only de locale
var faker = require('faker/locale/de');
var faker = require('@faker-js/faker/locale/de');
```

## Setting a randomness seed
Expand Down
38 changes: 19 additions & 19 deletions doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,23 @@
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">

<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="faker.html">faker</a></li><li><a href="faker.address.html">faker.address</a></li><li><a href="faker.animal.html">faker.animal</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.datatype.html">faker.datatype</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#arrayRemove">arrayRemove</a></li><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">
Expand All @@ -56,7 +56,7 @@
</div>
</form>
</div>

</div>

</div>
Expand All @@ -66,14 +66,11 @@
<div class="container" id="toc-content">
<div class="row">


<div class="col-md-8">

<div id="main">







Expand All @@ -85,8 +82,11 @@













Expand Down Expand Up @@ -116,7 +116,7 @@ <h3>Browser</h3>
&lt;/script>
</code></pre>
<h3>Node.js</h3>
<pre class="prettyprint source lang-js"><code> var faker = require('faker');
<pre class="prettyprint source lang-js"><code> var faker = require('@faker-js/faker');

var randomName = faker.name.findName(); // Rowan Nikolaus
var randomEmail = faker.internet.email(); // [email protected]
Expand Down Expand Up @@ -502,7 +502,7 @@ <h3>Individual Localization Packages</h3>
<p>By default, requiring <code>faker</code> will include <em>all</em> locale data.</p>
<p>In a production environment, you may only want to include the locale data for a specific set of locales.</p>
<pre class="prettyprint source lang-js"><code>// loads only de locale
var faker = require('faker/locale/de');
var faker = require('@faker-js/faker/locale/de');
</code></pre>
<h2>Setting a randomness seed</h2>
<p>If you want consistent results, you can set your own seed:</p>
Expand Down Expand Up @@ -642,11 +642,11 @@ <h2>Sponsors</h2>

<div class="clearfix"></div>


<div class="col-md-3">
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
</div>


</div>
</div>
Expand All @@ -673,9 +673,9 @@ <h4 class="modal-title">Search results</h4>

<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a>

on 2021-03-30T13:03:12-04:00

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
Expand Down Expand Up @@ -765,4 +765,4 @@ <h4 class="modal-title">Search results</h4>


</body>
</html>
</html>
2 changes: 1 addition & 1 deletion doc/quicksearch.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/api/localization.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,5 @@ In a production environment, you may only want to include the locale data for a

```js
// loads only de locale
const faker = require('faker/locale/de');
const faker = require('@faker-js/faker/locale/de');
```
2 changes: 1 addition & 1 deletion docs/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ npm install @faker-js/faker --save-dev
### Node.js

```js
import faker from 'faker';
import faker from '@faker-js/faker';

const randomName = faker.name.findName(); // Rowan Nikolaus
const randomEmail = faker.internet.email(); // [email protected]
Expand Down