diff options
| author | Matt Mayer <[email protected]> | 2022-11-28 00:12:16 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-11-27 18:12:16 +0100 |
| commit | b5041943097397325044005be21b97306c61012e (patch) | |
| tree | de1540dd6266035e4b01cd8a6091224e495606ba /docs | |
| parent | 795ca8cc52b357e03447a282469c6d1fb44fc960 (diff) | |
| download | faker-b5041943097397325044005be21b97306c61012e.tar.xz faker-b5041943097397325044005be21b97306c61012e.zip | |
docs: refactor migration guide (#1609)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/guide/upgrading.md | 38 |
1 files changed, 32 insertions, 6 deletions
diff --git a/docs/guide/upgrading.md b/docs/guide/upgrading.md index 11bf4d13..a5e0dfee 100644 --- a/docs/guide/upgrading.md +++ b/docs/guide/upgrading.md @@ -12,11 +12,13 @@ Not the version you are looking for? ::: -## `faker.mersenne` and `faker.helpers.repeatString` removed +## 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 replaced +### Other deprecated methods removed/replaced | Old method | New method | | ------------------------------- | ----------------------------------------------------------------- | @@ -27,8 +29,19 @@ Not the version you are looking for? | `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` +### `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.*` @@ -50,7 +63,7 @@ The `faker.name.*` methods will continue to work as an alias in v8 and v9, but i | `faker.name.jobType` | `faker.person.jobType` | | `faker.name.findName` | _Removed, replace with `faker.person.fullName`_ | -## `faker.address` changed to `faker.location` +### `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.*` @@ -84,6 +97,19 @@ The `faker.address.*` methods will continue to work as an alias in v8 and v9, bu | `faker.address.streetPrefix` | _Removed_ | | `faker.address.streetSuffix` | _Removed_ | -## Locale renamed +### Number methods of `faker.datatype` moved to new `faker.number` module -The `en_IND` (English, India) locale was renamed to `en_IN` for consistency with other locales. +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` | |