refactor(location)!: rename address module (#1469)

Co-authored-by: ST-DDT <[email protected]>

1 files changed, 0 insertions, 453 deletions

diff --git a/src/modules/address/index.ts b/src/modules/address/index.ts
deleted file mode 100644
index 4d484651..00000000
--- a/src/modules/address/index.ts
+++ /dev/null
@@ -1,453 +0,0 @@
-import type { Faker } from '../..';
-
-/**
- * Module to generate addresses and locations.
- */
-export class AddressModule {
-  constructor(private readonly faker: Faker) {
-    // Bind `this` so namespaced is working correctly
-    for (const name of Object.getOwnPropertyNames(AddressModule.prototype)) {
-      if (name === 'constructor' || typeof this[name] !== 'function') {
-        continue;
-      }
-      this[name] = this[name].bind(this);
-    }
-  }
-
-  /**
-   * Generates random zip code from specified format. If format is not specified,
-   * the locale's zip format is used.
-   *
-   * @param format The optional format used to generate the the zip code.
-   * By default, a random format is used from the locale zip formats.
-   *
-   * @see faker.helpers.replaceSymbols()
-   *
-   * @example
-   * faker.address.zipCode() // '17839'
-   * faker.address.zipCode('####') // '6925'
-   *
-   * @since 2.0.1
-   */
-  zipCode(format?: string): string {
-    // if zip format is not specified, use the zip format defined for the locale
-    if (format == null) {
-      const localeFormat = this.faker.definitions.address.postcode;
-      if (typeof localeFormat === 'string') {
-        format = localeFormat;
-      } else {
-        format = this.faker.helpers.arrayElement(localeFormat);
-      }
-    }
-    return this.faker.helpers.replaceSymbols(format);
-  }
-
-  /**
-   * Generates random zip code from state abbreviation. If state abbreviation is
-   * not specified, a random zip code is generated according to the locale's zip format.
-   * Only works for locales with postcode_by_state definition. If a locale does not
-   * have a postcode_by_state definition, a random zip code is generated according
-   * to the locale's zip format.
-   *
-   * @param state The abbreviation of the state to generate the zip code for.
-   *
-   * @example
-   * fakerUS.address.zipCodeByState("AK") // '99595'
-   * fakerUS.address.zipCodeByState("??") // '47683-9880'
-   *
-   * @since 5.0.0
-   */
-  zipCodeByState(state: string): string {
-    const zipRange = this.faker.definitions.address.postcode_by_state?.[state];
-    if (zipRange) {
-      return String(this.faker.datatype.number(zipRange));
-    }
-    return this.zipCode();
-  }
-
-  /**
-   * Generates a random localized city name.
-   *
-   * @example
-   * faker.address.city() // 'East Jarretmouth'
-   *
-   * @since 2.0.1
-   */
-  city(): string {
-    const pattern = this.faker.helpers.arrayElement(
-      this.faker.definitions.address.city
-    );
-    return this.faker.helpers.fake(pattern);
-  }
-
-  /**
-   * Returns a random localized and existing city name.
-   *
-   * @example
-   * faker.address.cityName() // 'San Rafael'
-   *
-   * @since 5.5.0
-   */
-  cityName(): string {
-    return this.faker.helpers.arrayElement(
-      this.faker.definitions.address.city_name
-    );
-  }
-
-  /**
-   * Generates a random building number.
-   *
-   * @example
-   * faker.address.buildingNumber() // '379'
-   *
-   * @since 6.2.0
-   */
-  buildingNumber(): string {
-    const format = this.faker.helpers.arrayElement(
-      this.faker.definitions.address.building_number
-    );
-
-    return this.faker.helpers.replaceSymbolWithNumber(format);
-  }
-
-  /**
-   * Generates a random localized street name.
-   *
-   * @example
-   * faker.address.street() // 'Schroeder Isle'
-   *
-   * @since 7.0.0
-   */
-  street(): string {
-    const format = this.faker.helpers.arrayElement(
-      this.faker.definitions.address.street
-    );
-    return this.faker.helpers.fake(format);
-  }
-
-  /**
-   * Returns a random localized street name.
-   *
-   * @example
-   * fakerDE.address.streetName() // 'Cavill Avenue'
-   *
-   * @since 2.0.1
-   */
-  streetName(): string {
-    return this.faker.helpers.arrayElement(
-      this.faker.definitions.address.street_name
-    );
-  }
-
-  /**
-   * Generates a random localized street address.
-   *
-   * @param useFullAddress When true this will generate a full address.
-   * Otherwise it will just generate a street address.
-   *
-   * @example
-   * faker.address.streetAddress() // '0917 O'Conner Estates'
-   * faker.address.streetAddress(false) // '34830 Erdman Hollow'
-   * faker.address.streetAddress(true) // '3393 Ronny Way Apt. 742'
-   *
-   * @since 2.0.1
-   */
-  streetAddress(useFullAddress: boolean = false): string {
-    const formats = this.faker.definitions.address.street_address;
-    const format = formats[useFullAddress ? 'full' : 'normal'];
-
-    return this.faker.helpers.fake(format);
-  }
-
-  /**
-   * Generates a random localized secondary address. This refers to a specific location at a given address
-   * such as an apartment or room number.
-   *
-   * @example
-   * faker.address.secondaryAddress() // 'Apt. 861'
-   *
-   * @since 2.0.1
-   */
-  secondaryAddress(): string {
-    return this.faker.helpers.replaceSymbolWithNumber(
-      this.faker.helpers.arrayElement(
-        this.faker.definitions.address.secondary_address
-      )
-    );
-  }
-
-  /**
-   * Returns a random localized county.
-   *
-   * @example
-   * faker.address.county() // 'Cambridgeshire'
-   *
-   * @since 2.0.1
-   */
-  county(): string {
-    return this.faker.helpers.arrayElement(
-      this.faker.definitions.address.county
-    );
-  }
-
-  /**
-   * Returns a random country name.
-   *
-   * @example
-   * faker.address.country() // 'Greece'
-   *
-   * @since 2.0.1
-   */
-  country(): string {
-    return this.faker.helpers.arrayElement(
-      this.faker.definitions.address.country
-    );
-  }
-
-  /**
-   * Returns a random country code.
-   *
-   * @param alphaCode The code to return. Can be either `'alpha-2'` (2 letter code)
-   * or `'alpha-3'` (three letter code). Defaults to `'alpha-2'`.
-   *
-   * @example
-   * faker.address.countryCode() // 'SJ'
-   * faker.address.countryCode('alpha-2') // 'GA'
-   * faker.address.countryCode('alpha-3') // 'TJK'
-   *
-   * @since 3.0.0
-   */
-  countryCode(alphaCode: 'alpha-2' | 'alpha-3' = 'alpha-2'): string {
-    const key =
-      alphaCode === 'alpha-3' ? 'country_code_alpha_3' : 'country_code';
-
-    return this.faker.helpers.arrayElement(this.faker.definitions.address[key]);
-  }
-
-  /**
-   * Returns a random localized state from this country.
-   *
-   * @example
-   * faker.address.state() // 'Georgia'
-   *
-   * @since 2.0.1
-   */
-  state(): string {
-    return this.faker.helpers.arrayElement(
-      this.faker.definitions.address.state
-    );
-  }
-
-  /**
-   * Returns a random localized state's abbreviated name from this country.
-   *
-   * @example
-   * faker.address.stateAbbr() // 'ND'
-   *
-   * @since 2.0.1
-   */
-  stateAbbr(): string {
-    return this.faker.helpers.arrayElement(
-      this.faker.definitions.address.state_abbr
-    );
-  }
-
-  /**
-   * Generates a random latitude.
-   *
-   * @param max The upper bound for the latitude to generate. Defaults to `90`.
-   * @param min The lower bound for the latitude to generate. Defaults to `-90`.
-   * @param precision The number of decimal points of precision for the latitude. Defaults to `4`.
-   *
-   * @example
-   * faker.address.latitude() // -30.9501
-   * faker.address.latitude(10, -10, 5) // 2.68452
-   *
-   * @since 2.0.1
-   */
-  // TODO @xDivisionByZerox 2022-06-12 this signature should probably be an object for easier maintainability
-  latitude(max: number = 90, min: number = -90, precision: number = 4): number {
-    return this.faker.datatype.number({
-      min,
-      max,
-      precision: parseFloat(`${(0.0).toPrecision(precision)}1`),
-    });
-  }
-
-  /**
-   * Generates a random longitude.
-   *
-   * @param max The upper bound for the longitude to generate. Defaults to `180`.
-   * @param min The lower bound for the longitude to generate. Defaults to `-180`.
-   * @param precision The number of decimal points of precision for the longitude. Defaults to `4`.
-   *
-   * @example
-   * faker.address.longitude() // -154.0226
-   * faker.address.longitude(10, -10, 5) // -4.03620
-   *
-   * @since 2.0.1
-   */
-  // TODO @xDivisionByZerox 2022-06-12 this signature should probably be an object for easier maintainability
-  longitude(
-    max: number = 180,
-    min: number = -180,
-    precision: number = 4
-  ): number {
-    return this.faker.datatype.number({
-      max: max,
-      min: min,
-      precision: parseFloat(`${(0.0).toPrecision(precision)}1`),
-    });
-  }
-
-  /**
-   * Returns a random direction (cardinal and ordinal; northwest, east, etc).
-   *
-   * @param useAbbr If true this will return abbreviated directions (NW, E, etc).
-   * Otherwise this will return the long name. Defaults to `false`.
-   *
-   * @example
-   * faker.address.direction() // 'Northeast'
-   * faker.address.direction(false) // 'South'
-   * faker.address.direction(true) // 'NE'
-   *
-   * @since 5.0.0
-   */
-  direction(useAbbr: boolean = false): string {
-    if (!useAbbr) {
-      return this.faker.helpers.arrayElement(
-        this.faker.definitions.address.direction
-      );
-    }
-    return this.faker.helpers.arrayElement(
-      this.faker.definitions.address.direction_abbr
-    );
-  }
-
-  /**
-   * Returns a random cardinal direction (north, east, south, west).
-   *
-   * @param useAbbr If true this will return abbreviated directions (N, E, etc).
-   * Otherwise this will return the long name. Defaults to `false`.
-   *
-   * @example
-   * faker.address.cardinalDirection() // 'North'
-   * faker.address.cardinalDirection(false) // 'South'
-   * faker.address.cardinalDirection(true) // 'N'
-   *
-   * @since 5.0.0
-   */
-  cardinalDirection(useAbbr: boolean = false): string {
-    if (!useAbbr) {
-      return this.faker.helpers.arrayElement(
-        this.faker.definitions.address.direction.slice(0, 4)
-      );
-    }
-    return this.faker.helpers.arrayElement(
-      this.faker.definitions.address.direction_abbr.slice(0, 4)
-    );
-  }
-
-  /**
-   * Returns a random ordinal direction (northwest, southeast, etc).
-   *
-   * @param useAbbr If true this will return abbreviated directions (NW, SE, etc).
-   * Otherwise this will return the long name. Defaults to `false`.
-   *
-   * @example
-   * faker.address.ordinalDirection() // 'Northeast'
-   * faker.address.ordinalDirection(false) // 'Northwest'
-   * faker.address.ordinalDirection(true) // 'NE'
-   *
-   * @since 5.0.0
-   */
-  ordinalDirection(useAbbr: boolean = false): string {
-    if (!useAbbr) {
-      return this.faker.helpers.arrayElement(
-        this.faker.definitions.address.direction.slice(4, 8)
-      );
-    }
-    return this.faker.helpers.arrayElement(
-      this.faker.definitions.address.direction_abbr.slice(4, 8)
-    );
-  }
-
-  /**
-   * Generates a random GPS coordinate within the specified radius from the given coordinate.
-   *
-   * @param coordinate The original coordinate to get a new coordinate close to.
-   * If no coordinate is given, a random one will be chosen.
-   * @param radius The maximum distance from the given coordinate to the new coordinate. Defaults to `10`.
-   * @param isMetric If `true` assume the radius to be in kilometers. If `false` for miles. Defaults to `false`.
-   *
-   * @example
-   * faker.address.nearbyGPSCoordinate() // [ 33.8475, -170.5953 ]
-   * faker.address.nearbyGPSCoordinate([33, -170]) // [ 33.0165, -170.0636 ]
-   * faker.address.nearbyGPSCoordinate([33, -170], 1000, true) // [ 37.9163, -179.2408 ]
-   *
-   * @since 5.0.0
-   */
-  nearbyGPSCoordinate(
-    coordinate?: [latitude: number, longitude: number],
-    radius: number = 10,
-    isMetric: boolean = false
-  ): [latitude: number, longitude: number] {
-    // If there is no coordinate, the best we can do is return a random GPS coordinate.
-    if (coordinate === undefined) {
-      return [this.latitude(), this.longitude()];
-    }
-
-    const angleRadians = this.faker.datatype.float({
-      min: 0,
-      max: 2 * Math.PI,
-      precision: 0.00001,
-    }); // in ° radians
-
-    const radiusMetric = isMetric ? radius : radius * 1.60934; // in km
-    const errorCorrection = 0.995; // avoid float issues
-    const distanceInKm =
-      this.faker.datatype.float({
-        min: 0,
-        max: radiusMetric,
-        precision: 0.001,
-      }) * errorCorrection; // in km
-
-    /**
-     * The distance in km per degree for earth.
-     */
-    // TODO @Shinigami92 2022-04-26: Provide an option property to provide custom circumferences.
-    const kmPerDegree = 40_000 / 360; // in km/°
-
-    const distanceInDegree = distanceInKm / kmPerDegree; // in °
-
-    const newCoordinate: [latitude: number, longitude: number] = [
-      coordinate[0] + Math.sin(angleRadians) * distanceInDegree,
-      coordinate[1] + Math.cos(angleRadians) * distanceInDegree,
-    ];
-
-    // Box latitude [-90°, 90°]
-    newCoordinate[0] = newCoordinate[0] % 180;
-    if (newCoordinate[0] < -90 || newCoordinate[0] > 90) {
-      newCoordinate[0] = Math.sign(newCoordinate[0]) * 180 - newCoordinate[0];
-      newCoordinate[1] += 180;
-    }
-    // Box longitude [-180°, 180°]
-    newCoordinate[1] = (((newCoordinate[1] % 360) + 540) % 360) - 180;
-
-    return [newCoordinate[0], newCoordinate[1]];
-  }
-
-  /**
-   * Returns a random time zone.
-   *
-   * @example
-   * faker.address.timeZone() // 'Pacific/Guam'
-   *
-   * @since 5.1.0
-   */
-  timeZone(): string {
-    return this.faker.helpers.arrayElement(
-      this.faker.definitions.address.time_zone
-    );
-  }
-}