docs(helpers): document unique deprecation

faker-js · Apr 1, 2023 · 472ac39 · 472ac39
1 parent 4f33217
commit 472ac39
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 15 deletions.
diff --git a/docs/guide/upgrading.md b/docs/guide/upgrading.md
@@ -104,21 +104,21 @@ For more information refer to our [Localization Guide](localization).
 
 ### 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_                                                         |
-| `faker.image.lorempixel`        | _Removed, as the LoremPixel service is no longer available_       |
+| Old method                      | New method                                                                                                      |
+| ------------------------------- | --------------------------------------------------------------------------------------------------------------- |
+| `faker.unique`                  | `faker.helpers.unique` (:warning: please have a look at [#1785](https://github.com/faker-js/faker/issues/1785)) |
+| `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_                                                                                                       |
+| `faker.image.lorempixel`        | _Removed, as the LoremPixel service is no longer available_                                                     |
 
 ## Deprecations and other changes
 
@@ -220,3 +220,8 @@ The functions `faker.system.mimeType`, `faker.system.fileType` and `faker.system
 ### Locale renamed
 
 The `en_IND` (English, India) locale was renamed to `en_IN` for consistency with other locales.
+
+### `faker.helpers.unique` is planned to be outsourced
+
+The `faker.helpers.unique` method is planned to be outsourced to a separate package.  
+Please have a look at issue [#1785](https://github.com/faker-js/faker/issues/1785) for more details.
diff --git a/docs/guide/usage.md b/docs/guide/usage.md
@@ -249,4 +249,10 @@ const user = createRandomUser();
 
 By wrapping Faker's `email` function with the [`unique`](../api/helpers.md#unique) helper function, we ensure that the return value of `email` is always unique.
 
+::: warning
+The `faker.helpers.unique` is targeted to be removed from Faker in the future.  
+Please have a look at the issue [#1785](https://github.com/faker-js/faker/issues/1785).  
+We will update these docs once a replacement is available.
+:::
+
 Congratulations, you should now be able to create any complex object you desire. Happy faking 🥳.