Skip to content

Commit a973ee1

Browse files
authored
chore(docs): fix imports (faker-js#154)
1 parent cd4695a commit a973ee1

File tree

5 files changed

+24
-24
lines changed

5 files changed

+24
-24
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Coming soon!
6363
### Node.js
6464

6565
```js
66-
var faker = require('faker');
66+
var faker = require('@faker-js/faker');
6767
var randomName = faker.name.findName(); // Rowan Nikolaus
6868
var randomEmail = faker.internet.email(); // [email protected]
6969
var randomCard = faker.helpers.createCard(); // random contact card containing many properties
@@ -384,7 +384,7 @@ In a production environment, you may only want to include the locale data for a
384384

385385
```js
386386
// loads only de locale
387-
var faker = require('faker/locale/de');
387+
var faker = require('@faker-js/faker/locale/de');
388388
```
389389

390390
## Setting a randomness seed

doc/index.html

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,23 @@
2929
</div>
3030
<div class="navbar-collapse collapse" id="topNavigation">
3131
<ul class="nav navbar-nav">
32-
32+
3333
<li class="dropdown">
3434
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a>
3535
<ul class="dropdown-menu ">
3636
<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>
3737
</ul>
3838
</li>
39-
39+
4040
<li class="dropdown">
4141
<a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
4242
<ul class="dropdown-menu ">
4343
<li><a href="global.html#arrayRemove">arrayRemove</a></li><li><a href="global.html#unique">unique</a></li>
4444
</ul>
4545
</li>
46-
46+
4747
</ul>
48-
48+
4949
<div class="col-sm-3 col-md-3">
5050
<form class="navbar-form" role="search">
5151
<div class="input-group">
@@ -56,7 +56,7 @@
5656
</div>
5757
</form>
5858
</div>
59-
59+
6060
</div>
6161

6262
</div>
@@ -66,14 +66,11 @@
6666
<div class="container" id="toc-content">
6767
<div class="row">
6868

69-
69+
7070
<div class="col-md-8">
71-
71+
7272
<div id="main">
73-
7473

75-
76-
7774

7875

7976

@@ -85,8 +82,11 @@
8582

8683

8784

88-
89-
85+
86+
87+
88+
89+
9090

9191

9292

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

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

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

645-
645+
646646
<div class="col-md-3">
647647
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
648648
</div>
649-
649+
650650

651651
</div>
652652
</div>
@@ -673,9 +673,9 @@ <h4 class="modal-title">Search results</h4>
673673

674674
<span class="jsdoc-message">
675675
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a>
676-
676+
677677
on 2021-03-30T13:03:12-04:00
678-
678+
679679
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
680680
</span>
681681
</footer>
@@ -765,4 +765,4 @@ <h4 class="modal-title">Search results</h4>
765765

766766

767767
</body>
768-
</html>
768+
</html>

doc/quicksearch.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/api/localization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,5 +63,5 @@ In a production environment, you may only want to include the locale data for a
6363

6464
```js
6565
// loads only de locale
66-
const faker = require('faker/locale/de');
66+
const faker = require('@faker-js/faker/locale/de');
6767
```

docs/guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pnpm add @faker-js/faker --save-dev
4242
### Node.js
4343

4444
```js
45-
import faker from 'faker';
45+
import faker from '@faker-js/faker';
4646

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

0 commit comments

Comments
 (0)