Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add upgrading guide for v8 #1517

Merged
merged 17 commits into from
Nov 21, 2022
Merged

docs: add upgrading guide for v8 #1517

Changes from 6 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
7082ad7
docs: add upgrading guide
Shinigami92 Oct 30, 2022
3870a79
docs: add upgrading guide
matthewmayer Nov 4, 2022
63ab8b3
Update docs/guide/upgrading.md
Nov 5, 2022
11bdf71
Update docs/guide/upgrading.md
Nov 5, 2022
b88573f
docs: add upgrading guide
matthewmayer Nov 5, 2022
20db15e
Merge branch 'next' into chore/upgrading-to-8
ST-DDT Nov 5, 2022
f09b0fd
docs: add upgrading guide
matthewmayer Nov 5, 2022
f3c3262
Merge branch 'next' into chore/upgrading-to-8
ST-DDT Nov 5, 2022
40aba85
Update docs/guide/upgrading.md
Nov 6, 2022
e15875f
docs: add upgrading guide
matthewmayer Nov 7, 2022
452f76f
docs: add upgrading guide
matthewmayer Nov 12, 2022
00f432b
Merge branch 'next' into chore/upgrading-to-8
ST-DDT Nov 20, 2022
27dfbe5
Update docs/guide/upgrading.md
Nov 20, 2022
9365d28
Update docs/guide/upgrading.md
Nov 20, 2022
1ab0b4a
Update docs/guide/upgrading.md
Nov 20, 2022
b706fce
Update docs/guide/upgrading.md
Nov 20, 2022
02f09e4
Merge branch 'next' into chore/upgrading-to-8
Shinigami92 Nov 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 81 additions & 51 deletions docs/guide/upgrading.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,59 +1,89 @@
# Upgrading to v7
# Upgrading to v8

This is the migration guide for upgrading from v6 to v7.
This is the migration guide for upgrading from v7 to v8.

Since v8 has not yet been released, this is a work in progress list of any major and breaking changes in v8.

::: info
Not the version you are looking for?

- [v6.fakerjs.dev](https://v6.fakerjs.dev/migration-guide-v5/)
- [Upgrading to v6](https://v6.fakerjs.dev/migration-guide-v5/)
- [Upgrading to v7](https://fakerjs.dev/guide/upgrading.html)
ST-DDT marked this conversation as resolved.
Show resolved Hide resolved

:::

## Node 12 no longer supported

You need at least Node 14 to use Faker.

## Default export removed

If you were previously importing faker like this:

```js
import faker from '@faker-js/faker';
```

You must instead use:

```js
import { faker } from '@faker-js/faker';
```

## Deprecated methods changed

Several methods were renamed or moved:

| Old method | New alternative |
| -------------------------- | ------------------------------------------------------ |
| faker.random.number | faker.datatype.number |
| faker.random.float | faker.datatype.float |
| faker.random.arrayElement | faker.helpers.arrayElement |
| faker.random.arrayElements | faker.helpers.arrayElements |
| faker.random.objectElement | faker.helpers.objectKey <br> faker.helpers.objectValue |
| faker.random.uuid | faker.datatype.uuid |
| faker.random.boolean | faker.datatype.boolean |
| faker.random.image | faker.image.image |
| faker.random.hexaDecimal | faker.datatype.hexadecimal |
| faker.helpers.randomize | faker.helpers.arrayElement |
| faker.datatype.hexaDecimal | faker.datatype.hexadecimal |
| faker.name.title | faker.name.jobTitle |

## Deprecated methods removed

Some methods were removed without a direct alternative. If you are using any of these methods you should build an object containing the specific properties you need.

| Removed method |
| ------------------------------- |
| faker.helpers.createCard |
| faker.helpers.contextualCard |
| faker.helpers.userCard |
| faker.time |
| faker.helpers.createTransaction |
## faker.mersenne and faker.helpers.repeatString removed
matthewmayer marked this conversation as resolved.
Show resolved Hide resolved

`faker.mersenne` and `faker.helpers.repeatString` were only ever intended for internal use, and are no longer available.

## Other deprecated methods replaced

| Old method | New method |
| ----------------------------- | ------------------------------------------------------------------ |
| faker.unique | faker.helpers.unique |
| faker.fake | faker.helpers.fake |
| faker.commerce.color | faker.color.human |
| faker.company.companyName | faker.company.name |
| faker.phone.phoneNumber | faker.phone.number |
| faker.phone.phoneNumberFormat | No direct replacement, `faker.phone.number` has a format parameter |
| faker.phone.phoneFormats | No direct replacement, `faker.phone.number` has a format parameter |

## faker.name changed to faker.person
matthewmayer marked this conversation as resolved.
Show resolved Hide resolved

The whole `faker.name` module is now located at `faker.person`, as it contains more information than just names.
The `faker.name.*` methods will continue to work as an alias in v8 and v9, but it is recommended to change to `faker.person.*`

| Old method | New method |
| ------------------------ | --------------------------------------------- |
| faker.name.firstName | faker.person.firstName |
| faker.name.lastName | faker.person.lastName |
| faker.name.middleName | faker.person.middleName |
| faker.name.fullName | faker.person.fullName |
| faker.name.gender | faker.person.gender |
| faker.name.sex | faker.person.sex |
| faker.name.sexType | faker.person.sexType |
| faker.name.prefix | faker.person.prefix |
| faker.name.suffix | faker.person.suffix |
| faker.name.jobTitle | faker.person.jobTitle |
| faker.name.jobDescriptor | faker.person.jobDescriptor |
| faker.name.jobArea | faker.person.jobArea |
| faker.name.jobType | faker.person.jobType |
| faker.name.findName | _Removed, replace with faker.person.fullName_ |

## faker.address changed to faker.location
matthewmayer marked this conversation as resolved.
Show resolved Hide resolved

The whole `faker.address` module is now located at `faker.location`, as it contains more information than just addresses.
The `faker.address.*` methods will continue to work as an alias in v8 and v9, but it is recommended to change to `faker.location.*`

| Old method | New method |
| --------------------------------- | ---------------------------------- |
| faker.address.buildingNumber | faker.location.buildingNumber |
| faker.address.cardinalDirection | faker.location.cardinalDirection |
| faker.address.city | faker.location.city |
| faker.address.cityName | faker.location.cityName |
| faker.address.country | faker.location.country |
| faker.address.countryCode | faker.location.countryCode |
| faker.address.county | faker.location.county |
| faker.address.direction | faker.location.direction |
| faker.address.faker | faker.location.faker |
| faker.address.latitude | faker.location.latitude |
| faker.address.longitude | faker.location.longitude |
| faker.address.nearbyGPSCoordinate | faker.location.nearbyGPSCoordinate |
| faker.address.ordinalDirection | faker.location.ordinalDirection |
| faker.address.secondaryAddress | faker.location.secondaryAddress |
| faker.address.state | faker.location.state |
| faker.address.stateAbbr | faker.location.stateAbbr |
| faker.address.street | faker.location.street |
| faker.address.streetAddress | faker.location.streetAddress |
| faker.address.streetName | faker.location.streetName |
| faker.address.timeZone | faker.location.timeZone |
| faker.address.zipCode | faker.location.zipCode |
| faker.address.zipCodeByState | faker.location.zipCodeByState |
| faker.address.cityPrefix | _Removed_ |
| faker.address.citySuffix | _Removed_ |
| faker.address.streetPrefix | _Removed_ |
| faker.address.streetSuffix | _Removed_ |

## Locale renamed

The `en-IND` (English, India) locale was renamed to `en-IN` for consistency with other locales.
matthewmayer marked this conversation as resolved.
Show resolved Hide resolved