Skip to content

Commit 2b9c766

Browse files
authored
Merge branch 'next' into remove-deprecated-git-method
2 parents 89d335b + 489bbc2 commit 2b9c766

File tree

5 files changed

+17
-56
lines changed

5 files changed

+17
-56
lines changed

docs/guide/upgrading_v9/2712.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
### Remove deprecated phone methods
2+
3+
Removed deprecated phone methods
4+
5+
| old | replacement |
6+
| ---------------------------- | -------------------------------------------------------------------------------- |
7+
| `faker.phone.number(format)` | `faker.phone.number()`, `faker.string.numeric()` or `faker.helpers.fromRegExp()` |

src/modules/phone/index.ts

Lines changed: 4 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import { deprecated } from '../../internal/deprecated';
21
import { ModuleBase } from '../../internal/module-base';
32
import { legacyReplaceSymbolWithNumber } from '../helpers';
43

@@ -21,54 +20,10 @@ export class PhoneModule extends ModuleBase {
2120
*
2221
* @since 7.3.0
2322
*/
24-
number(): string;
25-
/**
26-
* Generates a random phone number.
27-
*
28-
* @param format Format of the phone number.
29-
*
30-
* @see faker.string.numeric(): For generating a random string of numbers.
31-
* @see faker.helpers.fromRegExp(): For generating a phone number matching a regular expression.
32-
*
33-
* @example
34-
* faker.phone.number('501-###-###') // '501-039-841'
35-
* faker.phone.number('+48 91 ### ## ##') // '+48 91 463 61 70'
36-
*
37-
* @since 7.3.0
38-
*
39-
* @deprecated Use `faker.phone.number()` without an argument, `faker.string.numeric()` or `faker.helpers.fromRegExp()` instead.
40-
*/
41-
number(format: string): string;
42-
/**
43-
* Generates a random phone number.
44-
*
45-
* @param format Format of the phone number. Defaults to a random phone number format.
46-
*
47-
* @see faker.string.numeric(): For generating a random string of numbers.
48-
* @see faker.helpers.fromRegExp(): For generating a phone number matching a regular expression.
49-
*
50-
* @example
51-
* faker.phone.number() // '961-770-7727'
52-
*
53-
* @since 7.3.0
54-
*/
55-
number(format?: string): string;
56-
number(format?: string): string {
57-
if (format != null) {
58-
deprecated({
59-
deprecated: 'faker.phone.number(format)',
60-
proposed:
61-
'faker.phone.number(), faker.string.numeric() or faker.helpers.fromRegExp()',
62-
since: '8.1',
63-
until: '9.0',
64-
});
65-
}
66-
67-
format =
68-
format ??
69-
this.faker.helpers.arrayElement(
70-
this.faker.definitions.phone_number.formats
71-
);
23+
number(): string {
24+
const format = this.faker.helpers.arrayElement(
25+
this.faker.definitions.phone_number.formats
26+
);
7227
return legacyReplaceSymbolWithNumber(this.faker, format);
7328
}
7429

test/locale-imports.spec.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ describe.each(keys(allLocales))('locale imports', (locale) => {
3535
expect(metadata.code).toBeTypeOf('string');
3636
expect(metadata.code).toEqual(locale);
3737
if (locale !== 'base') {
38+
expect(metadata.code).toEqual(
39+
[metadata.language, metadata.country, metadata.variant]
40+
.filter((v) => v != null)
41+
.join('_')
42+
);
3843
expect(metadata.language).toBeTypeOf('string');
3944
expect(metadata.language).toMatch(/^[a-z]{2}$/);
4045
expect(metadata.script).toBeTypeOf('string');

test/modules/__snapshots__/phone.spec.ts.snap

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,12 @@
22

33
exports[`phone > 42 > imei 1`] = `"39-751108-670982-8"`;
44

5-
exports[`phone > 42 > number > format 1`] = `"397-511-0867"`;
6-
75
exports[`phone > 42 > number > noArgs 1`] = `"(975) 310-8670 x982"`;
86

97
exports[`phone > 1211 > imei 1`] = `"98-296673-687684-2"`;
108

11-
exports[`phone > 1211 > number > format 1`] = `"982-966-7368"`;
12-
139
exports[`phone > 1211 > number > noArgs 1`] = `"1-929-767-3687 x68488"`;
1410

1511
exports[`phone > 1337 > imei 1`] = `"21-243529-713619-6"`;
1612

17-
exports[`phone > 1337 > number > format 1`] = `"212-435-2971"`;
18-
1913
exports[`phone > 1337 > number > noArgs 1`] = `"324-452-9713 x619"`;

test/modules/phone.spec.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ describe('phone', () => {
1111
t.it('imei');
1212

1313
t.describe('number', (t) => {
14-
t.it('noArgs').it('format', '###-###-####');
14+
t.it('noArgs');
1515
});
1616
});
1717

0 commit comments

Comments
 (0)