chore: deprecate phone.phoneNumberFormat (#957)

1 files changed, 13 insertions, 2 deletions

diff --git a/src/modules/phone/index.ts b/src/modules/phone/index.ts
index 7e85915c..a4c79fc2 100644
--- a/src/modules/phone/index.ts
+++ b/src/modules/phone/index.ts
@@ -1,4 +1,5 @@
 import type { Faker } from '../..';
+import { deprecated } from '../../internal/deprecated';
 
 /**
  * Module to generate phone-related data.
@@ -36,13 +37,23 @@ export class Phone {
    *
    * @param phoneFormatsArrayIndex Index in the `faker.definitions.phone_number.formats` array. Defaults to `0`.
    *
+   * @see faker.phone.phoneNumber
+   * @see faker.helpers.replaceSymbolWithNumber
+   *
    * @example
    * faker.phone.phoneNumberFormat() // '943-627-0355'
    * faker.phone.phoneNumberFormat(3) // '282.652.3201'
+   *
+   * @deprecated
    */
-  // FIXME @Shinigami 2022-01-14: this is strange passing in an array index
-  // TODO @pkuczynski 2022-02-01: discuss removing this method as it tightly couples with localisation
   phoneNumberFormat(phoneFormatsArrayIndex = 0): string {
+    deprecated({
+      deprecated: 'faker.phone.phoneNumberFormat()',
+      proposed:
+        'faker.phone.phoneNumber() or faker.helpers.replaceSymbolWithNumber(format)',
+      since: 'v7.0',
+      until: 'v8.0',
+    });
     return this.faker.helpers.replaceSymbolWithNumber(
       this.faker.definitions.phone_number.formats[phoneFormatsArrayIndex]
     );