From ea620467165a9a2247b147edcf46ef0783325977 Mon Sep 17 00:00:00 2001 From: Shinigami Date: Tue, 4 Apr 2023 19:17:43 +0200 Subject: docs(helpers): document unique deprecation (#2001) --- docs/guide/usage.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/guide/usage.md') 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 🥳. -- cgit v1.2.3