feat: use localized fake pattern in street (#966)

1 files changed, 29 insertions, 17 deletions

diff --git a/src/modules/address/index.ts b/src/modules/address/index.ts
index 0030fac7..311138a5 100644
--- a/src/modules/address/index.ts
+++ b/src/modules/address/index.ts
@@ -143,24 +143,36 @@ export class Address {
    * Generates a random localized street name.
    *
    * @example
-   * faker.address.streetName() // 'Kulas Roads'
+   * faker.address.street() // 'Schroeder Isle'
    */
-  streetName(): string {
-    let result: string;
-    let suffix = this.streetSuffix();
-    if (suffix !== '') {
-      suffix = ` ${suffix}`;
-    }
+  street(): string {
+    const format = this.faker.helpers.arrayElement(
+      this.faker.definitions.address.street
+    );
+    return this.faker.fake(format);
+  }
 
-    switch (this.faker.datatype.number(1)) {
-      case 0:
-        result = this.faker.name.lastName() + suffix;
-        break;
-      case 1:
-        result = this.faker.name.firstName() + suffix;
-        break;
+  /**
+   * Returns a random localized street name.
+   *
+   * @example
+   * fakerDE.address.streetName() // 'Cavill Avenue'
+   */
+  streetName(): string {
+    if (this.faker.definitions.address.street_name == null) {
+      deprecated({
+        deprecated:
+          'faker.address.streetName() without address.street_name definitions',
+        proposed:
+          'faker.address.street() or provide address.street_name definitions',
+        since: 'v7.0',
+        until: 'v8.0',
+      });
+      return this.street();
     }
-    return result;
+    return this.faker.helpers.arrayElement(
+      this.faker.definitions.address.street_name
+    );
   }
 
   /**
@@ -170,9 +182,9 @@ export class Address {
    * Otherwise it will just generate a street address.
    *
    * @example
-   * faker.address.streetName() // '0917 O'Conner Estates'
-   * faker.address.streetAddress(true) // '3393 Ronny Way Apt. 742'
+   * faker.address.streetAddress() // '0917 O'Conner Estates'
    * faker.address.streetAddress(false) // '34830 Erdman Hollow'
+   * faker.address.streetAddress(true) // '3393 Ronny Way Apt. 742'
    */
   streetAddress(useFullAddress: boolean = false): string {
     const formats = this.faker.definitions.address.street_address;