|
18 | 18 |
|
19 | 19 | ## 📙 API Documentation |
20 | 20 |
|
21 | | -[Guide - Getting started](https://fakerjs.dev/guide/) |
| 21 | +<h1>⚠️ You are reading the docs for the <a href="https://github.com/faker-js/faker/tree/next">next</a> branch ⚠️</h1> |
| 22 | + |
| 23 | +Please proceed to the [Getting Started Guide](https://fakerjs.dev/guide/) for the **stable** release of Faker. |
22 | 24 |
|
23 | 25 | For detailed API documentation, please select the version of the documentation you are looking for. |
24 | 26 |
|
25 | | -| Version | Github | Website | |
26 | | -| :-----: | :----------------------------------------------------: | :------------------------ | |
27 | | -| release | [releases](https://github.com/faker-js/faker/releases) | https://fakerjs.dev/ | |
28 | | -| dev | [next](https://github.com/faker-js/faker/tree/next) | https://next.fakerjs.dev/ | |
29 | | -| v8.x.x | [v8](https://github.com/faker-js/faker/tree/v8) | https://v8.fakerjs.dev/ | |
30 | | -| v7.x.x | [v7](https://github.com/faker-js/faker/tree/v7) | https://v7.fakerjs.dev/ | |
31 | | -| v6.x.x | [v6](https://github.com/faker-js/faker/tree/v6) | https://v6.fakerjs.dev/ | |
| 27 | +| Version | Website | |
| 28 | +| :---------: | :------------------------ | |
| 29 | +| v8 (next) | https://next.fakerjs.dev/ | |
| 30 | +| v7 (stable) | https://fakerjs.dev/ | |
| 31 | +| v6 (old) | https://v6.fakerjs.dev/ | |
32 | 32 |
|
33 | 33 | --- |
34 | 34 |
|
@@ -87,34 +87,7 @@ Thus, limiting the import to a single locale can speed up startup times. |
87 | 87 |
|
88 | 88 | ## 💎 Modules |
89 | 89 |
|
90 | | -An in-depth overview of the API methods is available in the [documentation](https://fakerjs.dev/guide/). |
91 | | -The API covers the following modules: |
92 | | - |
93 | | -| Module | Example | Output | |
94 | | -| -------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------- | |
95 | | -| Airline | `faker.airline.airport()` | `{ name: 'Dallas Fort Worth International Airport', iataCode: 'DFW' }` | |
96 | | -| Animal | `faker.animal.cat()` | Norwegian Forest Cat | |
97 | | -| Color | `faker.color.rgb()` | #cdfcdc | |
98 | | -| Commerce | `faker.commerce.product()` | Polo t-shirt | |
99 | | -| Company | `faker.company.companyName()` | Zboncak and Sons | |
100 | | -| Database | `faker.database.engine()` | MyISAM | |
101 | | -| Datatype | `faker.datatype.uuid()` | 7b16dd12-935e-4acc-8381-b1e457bf0176 | |
102 | | -| Date | `faker.date.past()` | Sat Oct 20 2018 04:19:38 GMT-0700 (Pacific Daylight Time) | |
103 | | -| Finance | `faker.finance.amount()` | ¥23400 (After setting locale) | |
104 | | -| Git | `faker.git.commitMessage()` | feat: add products list page | |
105 | | -| Hacker | `faker.hacker.phrase()` | Try to reboot the SQL bus, maybe it will bypass the virtual application! | |
106 | | -| Helpers | `faker.helpers.arrayElement(['a', 'b', 'c'])` | b | |
107 | | -| Image | `faker.image.url()` | https://picsum.photos/id/165/640/480 <img src="https://picsum.photos/id/165/640/480" height="100"> | |
108 | | -| Internet | `faker.internet.domainName()` | muddy-neuropathologist.net | |
109 | | -| Location | `faker.location.city()` | Lake Raoulfort | |
110 | | -| Lorem | `faker.lorem.paragraph()` | Porro nulla id vero perspiciatis nulla nihil. ... | |
111 | | -| Music | `faker.music.genre()` | R&B | |
112 | | -| Person | `faker.person.firstName()` | Cameron | |
113 | | -| Phone | `faker.phone.phoneNumber()` | +1 291-299-0192 | |
114 | | -| Science | `faker.science.unit()` | `{ name: 'meter', symbol: 'm' }` | |
115 | | -| System | `faker.system.directoryPath()` | /root | |
116 | | -| Vehicle | `faker.vehicle.vehicle()` | Lamborghini Camry | |
117 | | -| Word | `faker.word.adjective()` | adorable | |
| 90 | +An in-depth overview of the API methods is available in the documentation for [v7 (stable)](https://fakerjs.dev/api/) and [v8 (next)](https://next.fakerjs.dev/api/). |
118 | 91 |
|
119 | 92 | ### Templates |
120 | 93 |
|
|
0 commit comments