diff options
| author | Shinigami <[email protected]> | 2023-05-08 10:36:43 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-05-08 08:36:43 +0000 |
| commit | 30b40ada8f9ed8195a7c088c5057d5a9748df897 (patch) | |
| tree | f100b4c775a53bf346fc63954e4568a51fdc5c3b /docs/guide/usage.md | |
| parent | 23eb0f5b3962f334dbbf8fda52b6639ff7b66a96 (diff) | |
| download | faker-30b40ada8f9ed8195a7c088c5057d5a9748df897.tar.xz faker-30b40ada8f9ed8195a7c088c5057d5a9748df897.zip | |
docs: minor enhancements (#2131)
Diffstat (limited to 'docs/guide/usage.md')
| -rw-r--r-- | docs/guide/usage.md | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/docs/guide/usage.md b/docs/guide/usage.md index 767cf747..452e415c 100644 --- a/docs/guide/usage.md +++ b/docs/guide/usage.md @@ -4,23 +4,28 @@ Using Faker is as easy as importing it from `@faker-js/faker`. -```js +::: code-group + +```js [esm] import { faker } from '@faker-js/faker'; // or, if desiring a different locale -// import { fakerDE as faker } from '@faker-js/faker' +// import { fakerDE as faker } from '@faker-js/faker'; + const randomName = faker.person.fullName(); // Rowan Nikolaus const randomEmail = faker.internet.email(); // [email protected] ``` -Or if you're using CommonJS: - -```js +```js [cjs] const { faker } = require('@faker-js/faker'); +// or, if desiring a different locale +// const { fakerDE: faker } = require('@faker-js/faker'); const randomName = faker.person.fullName(); // Rowan Nikolaus const randomEmail = faker.internet.email(); // [email protected] ``` +::: + For more information about changing and customizing the locales, please refer to our [Localization Guide](localization). ## Browser @@ -119,7 +124,7 @@ or alternatively you can set a default reference date for all these methods: ```ts // affects all future faker.date.* calls -faker.defaultRefDate = '2023-01-01T00:00:00.000Z'; +faker.setDefaultRefDate('2023-01-01T00:00:00.000Z'); ``` ## Create complex objects @@ -220,7 +225,7 @@ But, in most use-cases, this would be desirable. Faker has your back, with another helper method: -```ts {7-9} +```ts {7-10} import { faker } from '@faker-js/faker'; function createRandomUser(): User { |
