blob: a5e0dfee098b628cc6d4b3bb298f3df2f1a1f969 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
# Upgrading to v8
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?
- [Upgrading to v7](https://v7.fakerjs.dev/guide/upgrading.html)
- [Upgrading to v6](https://v6.fakerjs.dev/migration-guide-v5/)
:::
## Breaking changes
### `faker.mersenne` and `faker.helpers.repeatString` removed
`faker.mersenne` and `faker.helpers.repeatString` were only ever intended for internal use, and are no longer available.
### Other deprecated methods removed/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, see documentation for `faker.phone.number` |
| `faker.phone.phoneFormats` | No direct replacement, see documentation for `faker.phone.number` |
| `faker.name.findName` | _Removed, replace with `faker.person.fullName`_ |
| `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.
## Deprecations and other changes
### `faker.name` changed to `faker.person`
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`
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_ |
### Number methods of `faker.datatype` moved to new `faker.number` module
The number-related methods previously found in `faker.datatype` have been moved to a new `faker.number` module.
For the old `faker.datatype.number` method you should replace with `faker.number.int` or `faker.number.float` depending on the precision required.
faker.datatype.number() //35
faker.datatype.int() //35
faker.datatype.number({precision:0.01}) //35.21
faker.datatype.float({precision:0.01}) //35.21
| Old method | New method |
| ----------------------- | ------------------------------------------ |
| `faker.datatype.number` | `faker.number.int` or `faker.number.float` |
| `faker.datatype.float` | `faker.number.float` |
| `faker.datatype.bigInt` | `faker.number.bigInt` |
|
