From aa031bbaadd24b54855d0ccd5a515b659b3c55fe Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Leyla=20J=C3=A4hnig?= <leyla.jaehnig@gmx.de>
Date: Thu, 16 Jun 2022 21:53:21 +0200
Subject: refactor(phone): rename phoneNumber to number (#1063)

---
 src/modules/fake/index.ts  |  4 ++--
 src/modules/phone/index.ts | 25 ++++++++++++++++++++++++-
 2 files changed, 26 insertions(+), 3 deletions(-)

(limited to 'src/modules')

diff --git a/src/modules/fake/index.ts b/src/modules/fake/index.ts
index a94d8845..9dff1c8e 100644
--- a/src/modules/fake/index.ts
+++ b/src/modules/fake/index.ts
@@ -37,7 +37,7 @@ export class Fake {
    * and if that isn't possible, we will fall back to string:
    *
    * ```js
-   * const message = faker.fake(`You can call me at {{phone.phoneNumber(+!# !## #### #####!)}}.')
+   * const message = faker.fake(`You can call me at {{phone.number(+!# !## #### #####!)}}.')
    * ```
    *
    * Currently it is not possible to set more than a single parameter.
@@ -53,7 +53,7 @@ export class Fake {
    * faker.fake('{{name.lastName}}, {{name.firstName}} {{name.suffix}}') // 'Durgan, Noe MD'
    * faker.fake('This is static test.') // 'This is static test.'
    * faker.fake('Good Morning {{name.firstName}}!') // 'Good Morning Estelle!'
-   * faker.fake('You can call me at {{phone.phoneNumber(!## ### #####!)}}.') // 'You can call me at 202 555 973722.'
+   * faker.fake('You can call me at {{phone.number(!## ### #####!)}}.') // 'You can call me at 202 555 973722.'
    * faker.fake('I flipped the coin an got: {{helpers.arrayElement(["heads", "tails"])}}') // 'I flipped the coin an got: tails'
    */
   fake(str: string): string {
diff --git a/src/modules/phone/index.ts b/src/modules/phone/index.ts
index 925e087d..68f97bf6 100644
--- a/src/modules/phone/index.ts
+++ b/src/modules/phone/index.ts
@@ -20,13 +20,36 @@ export class Phone {
    *
    * @param format Format of the phone number. Defaults to a random phone number format.
    *
+   * @see faker.phone.number
+   *
    * @example
    * faker.phone.phoneNumber() // '961-770-7727'
    * faker.phone.phoneNumber('501-###-###') // '501-039-841'
    * faker.phone.phoneNumber('+48 91 ### ## ##') // '+48 91 463 61 70'
+   *
+   * @deprecated
    */
-  // TODO @pkuczynski 2022-02-01: simplify name to `number()`
   phoneNumber(format?: string): string {
+    deprecated({
+      deprecated: 'faker.phone.phoneNumber()',
+      proposed: 'faker.phone.number()',
+      since: 'v7.3',
+      until: 'v8.0',
+    });
+    return this.faker.phone.number(format);
+  }
+
+  /**
+   * Generates a random phone number.
+   *
+   * @param format Format of the phone number. Defaults to a random phone number format.
+   *
+   * @example
+   * faker.phone.number() // '961-770-7727'
+   * faker.phone.number('501-###-###') // '501-039-841'
+   * faker.phone.number('+48 91 ### ## ##') // '+48 91 463 61 70'
+   */
+  number(format?: string): string {
     format =
       format ??
       this.faker.helpers.arrayElement(
-- 
cgit v1.2.3