Faker.Timezone (Fakerer v1.2.0)

Copy Markdown View Source

Functions to generate IANA timezones from the tz database.

Summary

Functions

Returns a random alias IANA timezone.

Returns a random canonical IANA timezone.

Returns a random IANA timezone which may be an alias or a canonical timezone.

Functions

alias()

@spec alias() :: String.t()

Returns a random alias IANA timezone.

An alias timezone is a timezone that links to another timezone in the tz database.

Examples

iex> Faker.Timezone.alias()
"Turkey"
iex> Faker.Timezone.alias()
"Atlantic/Faeroe"
iex> Faker.Timezone.alias()
"America/Atikokan"
iex> Faker.Timezone.alias()
"US/Alaska"

canonical()

@spec canonical() :: String.t()

Returns a random canonical IANA timezone.

A canonical timezone is a timezone that is not an alias (a timezone that links to another timezone in the tz database).

Examples

iex> Faker.Timezone.canonical()
"Asia/Choibalsan"
iex> Faker.Timezone.canonical()
"America/Costa_Rica"
iex> Faker.Timezone.canonical()
"America/Bahia"
iex> Faker.Timezone.canonical()
"America/Dawson"

timezone()

@spec timezone() :: String.t()

Returns a random IANA timezone which may be an alias or a canonical timezone.

Examples

iex> Faker.Timezone.timezone()
"America/Costa_Rica"
iex> Faker.Timezone.timezone()
"US/Alaska"
iex> Faker.Timezone.timezone()
"Africa/Tripoli"
iex> Faker.Timezone.timezone()
"Asia/Vladivostok"