diff options
| author | ST-DDT <[email protected]> | 2023-03-07 10:09:29 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-03-07 09:09:29 +0000 |
| commit | 9a35dc92260585683132172f10bcdec701ed661a (patch) | |
| tree | 35a5711ba5a5fbc18a8f62515d1ae8b25af77023 /README.md | |
| parent | a4d5203511e6ea7e26bc8c75baf91ee44387cac0 (diff) | |
| download | faker-9a35dc92260585683132172f10bcdec701ed661a.tar.xz faker-9a35dc92260585683132172f10bcdec701ed661a.zip | |
refactor!: remove dynamic locale switching support (#1735)
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 23 insertions, 9 deletions
@@ -56,8 +56,11 @@ npm install --save-dev @faker-js/faker ## 🪄 Usage ```ts +// ESM import { faker } from '@faker-js/faker'; -// import { faker } from '@faker-js/faker/locale/de'; + +// CJS +const { faker } = require('@faker-js/faker'); export function createRandomUser(): User { return { @@ -108,7 +111,6 @@ The API covers the following modules: | Music | `faker.music.genre()` | R&B | | Person | `faker.person.firstName()` | Cameron | | Phone | `faker.phone.phoneNumber()` | +1 291-299-0192 | -| Random | `faker.random.locale()` | fr_CA | | Science | `faker.science.unit()` | `{ name: 'meter', symbol: 'm' }` | | System | `faker.system.directoryPath()` | /root | | Vehicle | `faker.vehicle.vehicle()` | Lamborghini Camry | @@ -130,18 +132,30 @@ console.log( Faker has support for multiple locales. -The default language locale is set to English. - -Setting a new locale is simple: +The main `faker` instance uses the English locale. +But you can also import instances using other locales. ```ts -// sets locale to de -faker.locale = 'de'; +// ESM +import { fakerDE as faker } from '@faker-js/faker'; + +// CJS +const { fakerDE: faker } = require('@faker-js/faker'); ``` -See our documentation for a list of [provided languages](https://fakerjs.dev/guide/localization.html#available-locales) +See our documentation for a list of [provided languages](https://fakerjs.dev/guide/localization.html#available-locales). + +Please note: Not every locale provides data for every module. In our pre-made faker instances, +we fall back to English in such a case as this is the most complete and most commonly used language. +If you don't want that or prefer a different fallback, you can also build your own instances. -Please note: not every locale provides data for every module. In our pre-made locales, we fallback to English in such a case as this is the most complete and most commonly used language. +```ts +import { Faker, de, de_CH } from '@faker-js/faker'; + +export const faker = new Faker({ + locale: [de_CH, de], +}); +``` ## ⚙️ Setting a randomness seed |
