aboutsummaryrefslogtreecommitdiff
path: root/src/modules
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2022-07-30 20:19:59 +0200
committerGitHub <[email protected]>2022-07-30 18:19:59 +0000
commitef6fbacfb15225b0f12fb5f6e6f382a0c3ed9915 (patch)
tree68a80c5a74ffffaca81fac7080c18a7861a3c4b1 /src/modules
parentaedd7b8bb0e6074f69659a79df1e6b75900f5894 (diff)
downloadfaker-ef6fbacfb15225b0f12fb5f6e6f382a0c3ed9915.tar.xz
faker-ef6fbacfb15225b0f12fb5f6e6f382a0c3ed9915.zip
chore: deprecate address.streetPrefix and suffix (#1053)
Diffstat (limited to 'src/modules')
-rw-r--r--src/modules/address/index.ts20
-rw-r--r--src/modules/random/index.ts1
2 files changed, 20 insertions, 1 deletions
diff --git a/src/modules/address/index.ts b/src/modules/address/index.ts
index 4c2469e1..28ba2c61 100644
--- a/src/modules/address/index.ts
+++ b/src/modules/address/index.ts
@@ -218,10 +218,20 @@ export class Address {
/**
* Returns a random localized street suffix.
*
+ * @see faker.address.street
+ *
* @example
* faker.address.streetSuffix() // 'Streets'
+ *
+ * @deprecated Use faker.address.street() instead.
*/
streetSuffix(): string {
+ deprecated({
+ deprecated: 'faker.address.streetSuffix()',
+ proposed: 'faker.address.street()',
+ since: '7.4',
+ until: '8.0',
+ });
return this.faker.helpers.arrayElement(
this.faker.definitions.address.street_suffix
);
@@ -230,10 +240,20 @@ export class Address {
/**
* Returns a random localized street prefix.
*
+ * @see faker.address.street
+ *
* @example
* fakerGH.address.streetPrefix() // 'Boame'
+ *
+ * @deprecated Use faker.address.street() instead.
*/
streetPrefix(): string {
+ deprecated({
+ deprecated: 'faker.address.streetPrefix()',
+ proposed: 'faker.address.street()',
+ since: '7.4',
+ until: '8.0',
+ });
return this.faker.helpers.arrayElement(
this.faker.definitions.address.street_prefix
);
diff --git a/src/modules/random/index.ts b/src/modules/random/index.ts
index 3071e33e..94bdcda1 100644
--- a/src/modules/random/index.ts
+++ b/src/modules/random/index.ts
@@ -129,7 +129,6 @@ export class Random {
this.faker.company.bsAdjective,
this.faker.company.bsBuzz,
this.faker.company.bsNoun,
- this.faker.address.streetSuffix,
this.faker.address.county,
this.faker.address.country,
this.faker.address.state,