diff options
| author | Shinigami <[email protected]> | 2022-10-17 04:05:05 +0800 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-10-16 22:05:05 +0200 |
| commit | 20f2236265467feb095cce5b5735bbadc07b9696 (patch) | |
| tree | ffb3b6a4c6c1f0e7e30b4d02e97de63789030ee1 /docs/guide | |
| parent | 90b9c5c39b8c193d41b7d3d9801e5b10360daa4c (diff) | |
| download | faker-20f2236265467feb095cce5b5735bbadc07b9696.tar.xz faker-20f2236265467feb095cce5b5735bbadc07b9696.zip | |
refactor(person)!: rename name module (#1445)
Co-authored-by: ST-DDT <[email protected]>
Diffstat (limited to 'docs/guide')
| -rw-r--r-- | docs/guide/usage.md | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/guide/usage.md b/docs/guide/usage.md index d37929d5..471d905e 100644 --- a/docs/guide/usage.md +++ b/docs/guide/usage.md @@ -7,7 +7,7 @@ Using Faker is as easy as importing it from `@faker-js/faker`. ```js import { faker } from '@faker-js/faker'; -const randomName = faker.name.fullName(); // Rowan Nikolaus +const randomName = faker.person.fullName(); // Rowan Nikolaus const randomEmail = faker.internet.email(); // [email protected] ``` @@ -16,7 +16,7 @@ Or if you using CommonJS ```js const { faker } = require('@faker-js/faker'); -const randomName = faker.name.fullName(); // Rowan Nikolaus +const randomName = faker.person.fullName(); // Rowan Nikolaus const randomEmail = faker.internet.email(); // [email protected] ``` @@ -27,7 +27,7 @@ const randomEmail = faker.internet.email(); // [email protected] import { faker } from 'https://cdn.skypack.dev/@faker-js/faker'; // Caitlyn Kerluke - const randomName = faker.name.fullName(); + const randomName = faker.person.fullName(); const randomEmail = faker.internet.email(); @@ -43,7 +43,7 @@ Using the browser is great for experimenting 👍. However, due to all of the st ```js import { faker } from 'https://cdn.skypack.dev/@faker-js/faker'; -const randomName = faker.name.findName(); // Willie Bahringer +const randomName = faker.person.findName(); // Willie Bahringer const randomEmail = faker.internet.email(); // [email protected] ``` @@ -120,9 +120,9 @@ function createRandomUser(): User { avatar: faker.image.avatar(), birthday: faker.date.birthdate(), email: faker.internet.email(), - firstName: faker.name.firstName(), - lastName: faker.name.lastName(), - sex: faker.name.sexType(), + firstName: faker.person.firstName(), + lastName: faker.person.lastName(), + sex: faker.person.sexType(), subscriptionTier: faker.helpers.arrayElement(['free', 'basic', 'business']), }; } @@ -142,9 +142,9 @@ Let's refactor our current code: import { faker } from '@faker-js/faker'; function createRandomUser(): User { - const sex = this.faker.name.sexType(); - const firstName = faker.name.firstName(sex); - const lastName = faker.name.lastName(); + const sex = this.faker.person.sexType(); + const firstName = faker.person.firstName(sex); + const lastName = faker.person.lastName(); const email = faker.internet.email(firstName, lastName); return { @@ -179,9 +179,9 @@ Faker has your back, with another helper method: import { faker } from '@faker-js/faker'; function createRandomUser(): User { - const sex = this.faker.name.sexType(); - const firstName = faker.name.firstName(sex); - const lastName = faker.name.lastName(); + const sex = this.faker.person.sexType(); + const firstName = faker.person.firstName(sex); + const lastName = faker.person.lastName(); const email = faker.helpers.unique(faker.internet.email, [ firstName, lastName, |
