aboutsummaryrefslogtreecommitdiff
path: root/src/modules/address
diff options
context:
space:
mode:
authorLeyla Jähnig <[email protected]>2022-06-18 11:16:48 +0200
committerGitHub <[email protected]>2022-06-18 11:16:48 +0200
commit6d3f42e606f905657fd597b022a49baddce7d9f4 (patch)
tree00515408cec154a35e2a0c191bf57521a7f8d00d /src/modules/address
parentc1cc1319373ab480b861c9cb372fa9e2ccf2982b (diff)
downloadfaker-6d3f42e606f905657fd597b022a49baddce7d9f4.tar.xz
faker-6d3f42e606f905657fd597b022a49baddce7d9f4.zip
docs: deprecation workflow (#1067)
Co-authored-by: Eric Cheng <[email protected]>
Diffstat (limited to 'src/modules/address')
-rw-r--r--src/modules/address/index.ts18
1 files changed, 10 insertions, 8 deletions
diff --git a/src/modules/address/index.ts b/src/modules/address/index.ts
index e3c568fd..7c55bb51 100644
--- a/src/modules/address/index.ts
+++ b/src/modules/address/index.ts
@@ -76,8 +76,8 @@ export class Address {
deprecated({
deprecated: 'faker.address.city(format)',
proposed: 'faker.address.city() or faker.fake(format)',
- since: 'v7.0',
- until: 'v8.0',
+ since: '7.0',
+ until: '8.0',
});
}
const formats = this.faker.definitions.address.city;
@@ -98,13 +98,14 @@ export class Address {
* faker.address.cityPrefix() // 'East'
*
* @deprecated
+ * Use `faker.address.city()` instead.
*/
cityPrefix(): string {
deprecated({
deprecated: 'faker.address.cityPrefix()',
proposed: "faker.address.city() or faker.fake('{{address.city_prefix}}')",
- since: 'v7.2',
- until: 'v8.0',
+ since: '7.2',
+ until: '8.0',
});
return this.faker.helpers.arrayElement(
this.faker.definitions.address.city_prefix
@@ -120,13 +121,14 @@ export class Address {
* faker.address.citySuffix() // 'mouth'
*
* @deprecated
+ * Use `faker.address.city()` instead.
*/
citySuffix(): string {
deprecated({
deprecated: 'faker.address.citySuffix()',
proposed: "faker.address.city() or faker.fake('{{address.city_suffix}}')",
- since: 'v7.2',
- until: 'v8.0',
+ since: '7.2',
+ until: '8.0',
});
return this.faker.helpers.arrayElement(
this.faker.definitions.address.city_suffix
@@ -185,8 +187,8 @@ export class Address {
'faker.address.streetName() without address.street_name definitions',
proposed:
'faker.address.street() or provide address.street_name definitions',
- since: 'v7.0',
- until: 'v8.0',
+ since: '7.0',
+ until: '8.0',
});
return this.street();
}