refactor(location)!: remove v8 deprecated location methods (#2753)

faker-js · Mar 18, 2024 · 6dee178 · 6dee178
1 parent e624d0e
commit 6dee178
Show file tree

Hide file tree

Showing 7 changed files with 117 additions and 871 deletions.
diff --git a/docs/guide/upgrading_v9/2753.md b/docs/guide/upgrading_v9/2753.md
@@ -0,0 +1,16 @@
+### Remove deprecated location methods
+
+Removed deprecated location methods
+
+| old                                                                | replacement                                                        |
+| ------------------------------------------------------------------ | ------------------------------------------------------------------ |
+| `faker.location.zipCodeByState`                                    | `faker.location.zipCode({ state })`                                |
+| `faker.location.cityName`                                          | `faker.location.city`                                              |
+| `faker.location.streetName`                                        | `faker.location.street`                                            |
+| `faker.location.stateAbbr()`                                       | `faker.location.state({ abbreviated: true })`                      |
+| `faker.location.latitude(max, min, precision)`                     | `faker.location.latitude({ max, min, precision })`                 |
+| `faker.location.longitude(max, min, precision)`                    | `faker.location.longitude({ max, min, precision })`                |
+| `faker.location.direction(abbreviated)`                            | `faker.location.direction({ abbreviated })`                        |
+| `faker.location.cardinalDirection(abbreviated)`                    | `faker.location.cardinalDirection({ abbreviated })`                |
+| `faker.location.ordinalDirection(abbreviated)`                     | `faker.location.ordinalDirection({ abbreviated })`                 |
+| `faker.location.nearbyGPSCoordinate(coordinate, radius, isMetric)` | `faker.location.nearbyGPSCoordinate({ origin, radius, isMetric })` |