diff options
Diffstat (limited to 'src/modules/phone')
| -rw-r--r-- | src/modules/phone/index.ts | 25 |
1 files changed, 24 insertions, 1 deletions
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( |
