diff options
| author | Shinigami <[email protected]> | 2024-03-05 15:49:25 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-03-05 14:49:25 +0000 |
| commit | 660da4c401b36ebfe0c0f7975c265146d9224921 (patch) | |
| tree | 8fb72813024dc076e3d210d958f0bd1d73a18c90 | |
| parent | e868060c87cbca3c1bf90465d61fc39a4eea1f9c (diff) | |
| download | faker-660da4c401b36ebfe0c0f7975c265146d9224921.tar.xz faker-660da4c401b36ebfe0c0f7975c265146d9224921.zip | |
refactor(phone)!: remove v8 deprecated phone format (#2712)
| -rw-r--r-- | docs/guide/upgrading_v9/2712.md | 7 | ||||
| -rw-r--r-- | src/modules/phone/index.ts | 53 | ||||
| -rw-r--r-- | test/modules/__snapshots__/phone.spec.ts.snap | 6 | ||||
| -rw-r--r-- | test/modules/phone.spec.ts | 2 |
4 files changed, 12 insertions, 56 deletions
diff --git a/docs/guide/upgrading_v9/2712.md b/docs/guide/upgrading_v9/2712.md new file mode 100644 index 00000000..660523f6 --- /dev/null +++ b/docs/guide/upgrading_v9/2712.md @@ -0,0 +1,7 @@ +### Remove deprecated phone methods + +Removed deprecated phone methods + +| old | replacement | +| ---------------------------- | -------------------------------------------------------------------------------- | +| `faker.phone.number(format)` | `faker.phone.number()`, `faker.string.numeric()` or `faker.helpers.fromRegExp()` | diff --git a/src/modules/phone/index.ts b/src/modules/phone/index.ts index 833938d7..44f2a111 100644 --- a/src/modules/phone/index.ts +++ b/src/modules/phone/index.ts @@ -1,4 +1,3 @@ -import { deprecated } from '../../internal/deprecated'; import { ModuleBase } from '../../internal/module-base'; import { legacyReplaceSymbolWithNumber } from '../helpers'; @@ -21,54 +20,10 @@ export class PhoneModule extends ModuleBase { * * @since 7.3.0 */ - number(): string; - /** - * Generates a random phone number. - * - * @param format Format of the phone number. - * - * @see faker.string.numeric(): For generating a random string of numbers. - * @see faker.helpers.fromRegExp(): For generating a phone number matching a regular expression. - * - * @example - * faker.phone.number('501-###-###') // '501-039-841' - * faker.phone.number('+48 91 ### ## ##') // '+48 91 463 61 70' - * - * @since 7.3.0 - * - * @deprecated Use `faker.phone.number()` without an argument, `faker.string.numeric()` or `faker.helpers.fromRegExp()` instead. - */ - number(format: string): string; - /** - * Generates a random phone number. - * - * @param format Format of the phone number. Defaults to a random phone number format. - * - * @see faker.string.numeric(): For generating a random string of numbers. - * @see faker.helpers.fromRegExp(): For generating a phone number matching a regular expression. - * - * @example - * faker.phone.number() // '961-770-7727' - * - * @since 7.3.0 - */ - number(format?: string): string; - number(format?: string): string { - if (format != null) { - deprecated({ - deprecated: 'faker.phone.number(format)', - proposed: - 'faker.phone.number(), faker.string.numeric() or faker.helpers.fromRegExp()', - since: '8.1', - until: '9.0', - }); - } - - format = - format ?? - this.faker.helpers.arrayElement( - this.faker.definitions.phone_number.formats - ); + number(): string { + const format = this.faker.helpers.arrayElement( + this.faker.definitions.phone_number.formats + ); return legacyReplaceSymbolWithNumber(this.faker, format); } diff --git a/test/modules/__snapshots__/phone.spec.ts.snap b/test/modules/__snapshots__/phone.spec.ts.snap index 2f60813c..20928c04 100644 --- a/test/modules/__snapshots__/phone.spec.ts.snap +++ b/test/modules/__snapshots__/phone.spec.ts.snap @@ -2,18 +2,12 @@ exports[`phone > 42 > imei 1`] = `"39-751108-670982-8"`; -exports[`phone > 42 > number > format 1`] = `"397-511-0867"`; - exports[`phone > 42 > number > noArgs 1`] = `"(975) 310-8670 x982"`; exports[`phone > 1211 > imei 1`] = `"98-296673-687684-2"`; -exports[`phone > 1211 > number > format 1`] = `"982-966-7368"`; - exports[`phone > 1211 > number > noArgs 1`] = `"1-929-767-3687 x68488"`; exports[`phone > 1337 > imei 1`] = `"21-243529-713619-6"`; -exports[`phone > 1337 > number > format 1`] = `"212-435-2971"`; - exports[`phone > 1337 > number > noArgs 1`] = `"324-452-9713 x619"`; diff --git a/test/modules/phone.spec.ts b/test/modules/phone.spec.ts index 4ee42417..4e1a76a3 100644 --- a/test/modules/phone.spec.ts +++ b/test/modules/phone.spec.ts @@ -11,7 +11,7 @@ describe('phone', () => { t.it('imei'); t.describe('number', (t) => { - t.it('noArgs').it('format', '###-###-####'); + t.it('noArgs'); }); }); |
