Faker.Address (Faker v0.16.0) View Source

Functions for generating addresses.

Link to this section Summary

Functions

Return random building number.

Return city name.

Return city prefix.

Return city suffix.

Return country.

Return country code.

Returns a geohash.

Return random latitude.

Return random longitude.

Return random postcode.

Return random secondary address.

Return state.

Return state abbr.

Return street address.

Return street_address/0 or if argument is true adds secondary_address/0.

Return street name.

Return street suffix.

Return time zone.

Return random postcode.

Return random postcode.

Link to this section Functions

Specs

building_number() :: String.t()

Return random building number.

Examples

iex> Faker.Address.building_number()
"15426"
iex> Faker.Address.building_number()
"6"
iex> Faker.Address.building_number()
"0832"
iex> Faker.Address.building_number()
"7"

Specs

city() :: String.t()

Return city name.

Examples

iex> Faker.Address.city()
"Elizabeth"
iex> Faker.Address.city()
"Rolfson"
iex> Faker.Address.city()
"West Conor"
iex> Faker.Address.city()
"Hardy"

Specs

city_prefix() :: String.t()

Return city prefix.

Examples

iex> Faker.Address.city_prefix()
"Port"
iex> Faker.Address.city_prefix()
"West"
iex> Faker.Address.city_prefix()
"North"
iex> Faker.Address.city_prefix()
"Lake"

Specs

city_suffix() :: String.t()

Return city suffix.

Examples

iex> Faker.Address.city_suffix()
"burgh"
iex> Faker.Address.city_suffix()
"mouth"
iex> Faker.Address.city_suffix()
"burgh"
iex> Faker.Address.city_suffix()
"view"

Specs

country() :: String.t()

Return country.

Examples

iex> Faker.Address.country()
"China"
iex> Faker.Address.country()
"Macedonia"
iex> Faker.Address.country()
"China"
iex> Faker.Address.country()
"Venezuela"

Specs

country_code() :: String.t()

Return country code.

Examples

iex> Faker.Address.country_code()
"IT"
iex> Faker.Address.country_code()
"MR"
iex> Faker.Address.country_code()
"GM"
iex> Faker.Address.country_code()
"CX"

Specs

geohash() :: binary()

Returns a geohash.

Examples

iex> Faker.Address.geohash()
"1kgw0"
iex> Faker.Address.geohash()
"575152tr612btt"
iex> Faker.Address.geohash()
"20kxxzd9k22m6jedp"
iex> Faker.Address.geohash()
"06kjmd2wtwjp2px"

Specs

latitude() :: float()

Return random latitude.

Examples

iex> Faker.Address.latitude()
-62.20459142744528
iex> Faker.Address.latitude()
-59.39243543011051
iex> Faker.Address.latitude()
15.346881460762518
iex> Faker.Address.latitude()
-72.94522080668256

Specs

longitude() :: float()

Return random longitude.

Examples

iex> Faker.Address.longitude()
-124.40918285489056
iex> Faker.Address.longitude()
-118.78487086022102
iex> Faker.Address.longitude()
30.693762921525035
iex> Faker.Address.longitude()
-145.8904416133651

Specs

postcode() :: String.t()

Return random postcode.

Examples

iex> Faker.Address.postcode()
"01542"
iex> Faker.Address.postcode()
"64610"
iex> Faker.Address.postcode()
"83297"
iex> Faker.Address.postcode()
"05235"

Specs

secondary_address() :: String.t()

Return random secondary address.

Examples

iex> Faker.Address.secondary_address()
"Apt. 154"
iex> Faker.Address.secondary_address()
"Apt. 646"
iex> Faker.Address.secondary_address()
"Suite 083"
iex> Faker.Address.secondary_address()
"Apt. 970"

Specs

state() :: String.t()

Return state.

Examples

iex> Faker.Address.state()
"Hawaii"
iex> Faker.Address.state()
"Alaska"
iex> Faker.Address.state()
"Oklahoma"
iex> Faker.Address.state()
"California"

Specs

state_abbr() :: String.t()

Return state abbr.

Examples

iex> Faker.Address.state_abbr()
"HI"
iex> Faker.Address.state_abbr()
"AK"
iex> Faker.Address.state_abbr()
"OK"
iex> Faker.Address.state_abbr()
"CA"

Specs

street_address() :: String.t()

Return street address.

Examples

iex> Faker.Address.street_address()
"15426 Aniya Mews"
iex> Faker.Address.street_address()
"83297 Jana Spring"
iex> Faker.Address.street_address()
"57 Helene Mission"
iex> Faker.Address.street_address()
"03 Izaiah Land"

Specs

street_address(true | any()) :: String.t()

Return street_address/0 or if argument is true adds secondary_address/0.

Examples

iex> Faker.Address.street_address(true)
"15426 Aniya Mews Apt. 832"
iex> Faker.Address.street_address(true)
"7 Jana Spring Suite 570"
iex> Faker.Address.street_address(true)
"030 Kozey Knoll Suite 733"
iex> Faker.Address.street_address(true)
"603 Homenick Shore Suite 981"

Specs

street_name() :: String.t()

Return street name.

Examples

iex> Faker.Address.street_name()
"Elizabeth Freeway"
iex> Faker.Address.street_name()
"Reese Plaza"
iex> Faker.Address.street_name()
"Aniya Mews"
iex> Faker.Address.street_name()
"Bianka Heights"

Specs

street_suffix() :: String.t()

Return street suffix.

Examples

iex> Faker.Address.street_suffix()
"View"
iex> Faker.Address.street_suffix()
"Locks"
iex> Faker.Address.street_suffix()
"Freeway"
iex> Faker.Address.street_suffix()
"Lodge"

Specs

time_zone() :: String.t()

Return time zone.

Examples

iex> Faker.Address.time_zone()
"Europe/Istanbul"
iex> Faker.Address.time_zone()
"Europe/Copenhagen"
iex> Faker.Address.time_zone()
"America/Indiana/Indianapolis"
iex> Faker.Address.time_zone()
"America/Guyana"

Specs

zip() :: String.t()

Return random postcode.

Examples

iex> Faker.Address.zip()
"01542"
iex> Faker.Address.zip()
"64610"
iex> Faker.Address.zip()
"83297"
iex> Faker.Address.zip()
"05235"

Specs

zip_code() :: String.t()

Return random postcode.

Examples

iex> Faker.Address.zip_code()
"01542"
iex> Faker.Address.zip_code()
"64610"
iex> Faker.Address.zip_code()
"83297"
iex> Faker.Address.zip_code()
"05235"