chore(lorempicsum.avatar): deprecate (#1065)

1 files changed, 11 insertions, 1 deletions

diff --git a/src/modules/image/providers/lorempicsum.ts b/src/modules/image/providers/lorempicsum.ts
index 25869205..77f5d0c6 100644
--- a/src/modules/image/providers/lorempicsum.ts
+++ b/src/modules/image/providers/lorempicsum.ts
@@ -1,4 +1,5 @@
 import type { Faker } from '../../..';
+import { deprecated } from '../../../internal/deprecated';
 
 /**
  * Module to generate links to random images on `https://picsum.photos/`.
@@ -73,12 +74,21 @@ export class LoremPicsum {
   /**
    * Returns a random avatar url.
    *
+   * @see faker.internet.avatar()
+   *
    * @example
    * faker.internet.avatar()
    * // 'https://cloudflare-ipfs.com/ipfs/Qmd3W5DuhgHirLHGVixi6V76LhCkZUz6pnFt5AJBiyvHye/avatar/315.jpg'
+   *
+   * @deprecated
    */
-  // TODO ST-DDT 2022-03-11: Deprecate this method as it is duplicate and has nothing to do with lorempicsum.
   avatar(): string {
+    deprecated({
+      deprecated: 'faker.image.lorempicsum.avatar()',
+      proposed: 'faker.internet.avatar()',
+      since: '7.3',
+      until: '8.0',
+    });
     return this.faker.internet.avatar();
   }