diff options
| author | Shinigami <[email protected]> | 2023-04-04 19:17:43 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-04-04 19:17:43 +0200 |
| commit | ea620467165a9a2247b147edcf46ef0783325977 (patch) | |
| tree | 2e500c5d886aa534e4ce9c2ab731632a800ab313 /docs/guide/usage.md | |
| parent | cddbb959f13aa29a7264174b1fc4eaa4271cf900 (diff) | |
| download | faker-ea620467165a9a2247b147edcf46ef0783325977.tar.xz faker-ea620467165a9a2247b147edcf46ef0783325977.zip | |
docs(helpers): document unique deprecation (#2001)
Diffstat (limited to 'docs/guide/usage.md')
| -rw-r--r-- | docs/guide/usage.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/guide/usage.md b/docs/guide/usage.md index f97590af..767cf747 100644 --- 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 🥳. |