diff options
| author | Matt Mayer <[email protected]> | 2023-03-29 20:36:46 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-03-29 13:36:46 +0000 |
| commit | 3562e872530b3610d95be71aa6f4f7fdfef7134f (patch) | |
| tree | c6ba28a9f3cf30e5bf5c0a935fead6bdb2668531 /src/modules/location | |
| parent | 88e561a5490003a41665eb007c5c28ff0800ae09 (diff) | |
| download | faker-3562e872530b3610d95be71aa6f4f7fdfef7134f.tar.xz faker-3562e872530b3610d95be71aa6f4f7fdfef7134f.zip | |
docs: add overview guides to specific modules (#1929)
Diffstat (limited to 'src/modules/location')
| -rw-r--r-- | src/modules/location/index.ts | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/src/modules/location/index.ts b/src/modules/location/index.ts index 37d8f14f..ab158ecb 100644 --- a/src/modules/location/index.ts +++ b/src/modules/location/index.ts @@ -2,7 +2,15 @@ import type { Faker } from '../..'; import { deprecated } from '../../internal/deprecated'; /** - * Module to generate addresses and locations. + * Module to generate addresses and locations. Prior to Faker 8.0.0, this module was known as `faker.address`. + * + * ### Overview + * + * For a typical street address for a locale, use [`streetAddress()`](https://next.fakerjs.dev/api/location.html#streetaddress), [`city()`](https://next.fakerjs.dev/api/location.html#city), [`state()`](https://next.fakerjs.dev/api/location.html#state) (or [`stateAbbr()`](https://next.fakerjs.dev/api/location.html#stateabbr)), and [`zipCode()`](https://next.fakerjs.dev/api/location.html#zipcode). Most locales provide localized versions for a specific country. + * + * If you need latitude and longitude coordinates, use [`latitude()`](https://next.fakerjs.dev/api/location.html#latitude) and [`longitude()`](https://next.fakerjs.dev/api/location.html#longitude), or [`nearbyGPSCoordinate()`](https://next.fakerjs.dev/api/location.html#nearbygpscoordinate) for a latitude/longitude near a given location. + * + * For a random country, you can use [`country()`](https://next.fakerjs.dev/api/location.html#country) or [`countryCode()`](https://next.fakerjs.dev/api/location.html#countrycode). */ export class LocationModule { constructor(private readonly faker: Faker) { |
