chore: deprecate address.streetPrefix and suffix (#1053)

faker-js · Jul 30, 2022 · ef6fbac · ef6fbac
1 parent aedd7b8
commit ef6fbac
Show file tree

Hide file tree

Showing 20 changed files with 68 additions and 49 deletions.
diff --git a/src/locales/af_ZA/address/street.ts b/src/locales/af_ZA/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/de_CH/address/street.ts b/src/locales/de_CH/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/el/address/street.ts b/src/locales/el/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/en_AU/address/street.ts b/src/locales/en_AU/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/en_CA/address/street.ts b/src/locales/en_CA/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/en_GB/address/street.ts b/src/locales/en_GB/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/en_IE/address/street.ts b/src/locales/en_IE/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/en_IND/address/street.ts b/src/locales/en_IND/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/en_NG/address/street.ts b/src/locales/en_NG/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/en_US/address/street.ts b/src/locales/en_US/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/en_ZA/address/street.ts b/src/locales/en_ZA/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/fr_CA/address/street.ts b/src/locales/fr_CA/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/ne/address/street.ts b/src/locales/ne/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/pt_BR/address/street.ts b/src/locales/pt_BR/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/vi/address/street.ts b/src/locales/vi/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git a/src/locales/zu_ZA/address/street.ts b/src/locales/zu_ZA/address/street.ts
@@ -1,4 +1,4 @@
 export default [
-  '{{name.firstName}} {{address.streetSuffix}}',
-  '{{name.lastName}} {{address.streetSuffix}}',
+  '{{name.firstName}} {{address.street_suffix}}',
+  '{{name.lastName}} {{address.street_suffix}}',
 ];
diff --git 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
@@ -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,

diff --git a/test/__snapshots__/random.spec.ts.snap b/test/__snapshots__/random.spec.ts.snap
@@ -14,11 +14,11 @@ exports[`random > 42 > numeric > noArgs 1`] = `"4"`;
 
 exports[`random > 42 > numeric > withLength 1`] = `"47917"`;
 
-exports[`random > 42 > word 1`] = `"extend"`;
+exports[`random > 42 > word 1`] = `"impactful"`;
 
 exports[`random > 42 > words > noArgs 1`] = `"mobile Fish"`;
 
-exports[`random > 42 > words > withLength 1`] = `"extend Directives application Home Dam"`;
+exports[`random > 42 > words > withLength 1`] = `"impactful Directives transmit Home initiatives"`;
 
 exports[`random > 1211 > alpha > noArgs 1`] = `"y"`;
 
@@ -36,9 +36,9 @@ exports[`random > 1211 > numeric > withLength 1`] = `"94872"`;
 
 exports[`random > 1211 > word 1`] = `"Division"`;
 
-exports[`random > 1211 > words > noArgs 1`] = `"Turnpike Frozen Handcrafted"`;
+exports[`random > 1211 > words > noArgs 1`] = `"functionalities Frozen Baby"`;
 
-exports[`random > 1211 > words > withLength 1`] = `"Division Forward Supervisor Peso ivory"`;
+exports[`random > 1211 > words > withLength 1`] = `"Division Forward purple Supervisor Peso"`;
 
 exports[`random > 1337 > alpha > noArgs 1`] = `"g"`;
 
@@ -54,8 +54,8 @@ exports[`random > 1337 > numeric > noArgs 1`] = `"3"`;
 
 exports[`random > 1337 > numeric > withLength 1`] = `"35122"`;
 
-exports[`random > 1337 > word 1`] = `"leading"`;
+exports[`random > 1337 > word 1`] = `"Organic"`;
 
 exports[`random > 1337 > words > noArgs 1`] = `"Delaware"`;
 
-exports[`random > 1337 > words > withLength 1`] = `"leading black Kiribati Garden Indiana"`;
+exports[`random > 1337 > words > withLength 1`] = `"Organic Bike interactive core Montenegro"`;
diff --git a/test/__snapshots__/system.spec.ts.snap b/test/__snapshots__/system.spec.ts.snap
@@ -18,7 +18,7 @@ exports[`system > 42 > fileName > noArgs 1`] = `"mobile_fish.jxsc"`;
 
 exports[`system > 42 > fileName > with extensionCount 1`] = `"mobile_fish.jxsc.jardiff"`;
 
-exports[`system > 42 > filePath 1`] = `"/opt/bin/directives_application_home.ptid"`;
+exports[`system > 42 > filePath 1`] = `"/opt/bin/directives_transmit_home.ptid"`;
 
 exports[`system > 42 > fileType 1`] = `"image"`;
 
@@ -28,9 +28,9 @@ exports[`system > 42 > semver 1`] = `"3.7.9"`;
 
 exports[`system > 1211 > commonFileExt 1`] = `"htm"`;
 
-exports[`system > 1211 > commonFileName > noArgs 1`] = `"turnpike_frozen_handcrafted.mp4v"`;
+exports[`system > 1211 > commonFileName > noArgs 1`] = `"functionalities_frozen_baby.m2a"`;
 
-exports[`system > 1211 > commonFileName > with extension 1`] = `"turnpike_frozen_handcrafted.ext"`;
+exports[`system > 1211 > commonFileName > with extension 1`] = `"functionalities_frozen_baby.ext"`;
 
 exports[`system > 1211 > commonFileType 1`] = `"application"`;
 
@@ -40,11 +40,11 @@ exports[`system > 1211 > fileExt > noArgs 1`] = `"dic"`;
 
 exports[`system > 1211 > fileExt > with mimeType 1`] = `"map"`;
 
-exports[`system > 1211 > fileName > noArgs 1`] = `"turnpike_frozen_handcrafted.heifs"`;
+exports[`system > 1211 > fileName > noArgs 1`] = `"functionalities_frozen_baby.tsd"`;
 
-exports[`system > 1211 > fileName > with extensionCount 1`] = `"turnpike_frozen_handcrafted.heifs.oth"`;
+exports[`system > 1211 > fileName > with extensionCount 1`] = `"functionalities_frozen_baby.tsd.xml"`;
 
-exports[`system > 1211 > filePath 1`] = `"/var/log/forward_supervisor.z2"`;
+exports[`system > 1211 > filePath 1`] = `"/var/log/forward_purple.avi"`;
 
 exports[`system > 1211 > fileType 1`] = `"x-shader"`;
 
@@ -90,7 +90,7 @@ exports[`system > seed: 42 > fileExt() 1`] = `"lrm"`;
 
 exports[`system > seed: 42 > fileName() 1`] = `"mobile_fish.jxsc"`;
 
-exports[`system > seed: 42 > filePath() 1`] = `"/opt/bin/directives_application_home.ptid"`;
+exports[`system > seed: 42 > filePath() 1`] = `"/opt/bin/directives_transmit_home.ptid"`;
 
 exports[`system > seed: 42 > fileType() 1`] = `"image"`;
 
@@ -100,17 +100,17 @@ exports[`system > seed: 42 > semver() 1`] = `"3.7.9"`;
 
 exports[`system > seed: 1211 > commonFileExt() 1`] = `"htm"`;
 
-exports[`system > seed: 1211 > commonFileName() 1`] = `"turnpike_frozen_handcrafted.mp4v"`;
+exports[`system > seed: 1211 > commonFileName() 1`] = `"functionalities_frozen_baby.m2a"`;
 
 exports[`system > seed: 1211 > commonFileType() 1`] = `"application"`;
 
 exports[`system > seed: 1211 > directoryPath() 1`] = `"/var/log"`;
 
 exports[`system > seed: 1211 > fileExt() 1`] = `"dic"`;
 
-exports[`system > seed: 1211 > fileName() 1`] = `"turnpike_frozen_handcrafted.heifs"`;
+exports[`system > seed: 1211 > fileName() 1`] = `"functionalities_frozen_baby.tsd"`;
 
-exports[`system > seed: 1211 > filePath() 1`] = `"/var/log/forward_supervisor.z2"`;
+exports[`system > seed: 1211 > filePath() 1`] = `"/var/log/forward_purple.avi"`;
 
 exports[`system > seed: 1211 > fileType() 1`] = `"x-shader"`;