# `Faker.Address.Hy`
[🔗](https://github.com/artkay/fakerer/blob/v1.0.0/lib/faker/address/hy.ex#L1)

Functions for generating addresses in Armenian

# `building_number`

```elixir
@spec building_number() :: String.t()
```

Returns a random building number.

## Examples

    iex> Faker.Address.Hy.building_number()
    "1"
    iex> Faker.Address.Hy.building_number()
    "4"
    iex> Faker.Address.Hy.building_number()
    "64"
    iex> Faker.Address.Hy.building_number()
    "108"

# `city`

```elixir
@spec city() :: String.t()
```

Returns city name.

## Examples

    iex> Faker.Address.Hy.city()
    "Ստեփանավան"
    iex> Faker.Address.Hy.city()
    "Մարալիկ"
    iex> Faker.Address.Hy.city()
    "Ճամբարակ"
    iex> Faker.Address.Hy.city()
    "Մեղրի"

# `city_prefix`

```elixir
@spec city_prefix() :: String.t()
```

Returns city prefix.

## Examples

    iex> Faker.Address.Hy.city_prefix()
    "ք."

# `country`

```elixir
@spec country() :: String.t()
```

Returns country.

## Examples

    iex> Faker.Address.Hy.country()
    "Ֆրանսիա"
    iex> Faker.Address.Hy.country()
    "Նիդերլանդներ"
    iex> Faker.Address.Hy.country()
    "Ղազախստան"
    iex> Faker.Address.Hy.country()
    "Թուրքմենստան"

# `secondary_address`

```elixir
@spec secondary_address() :: String.t()
```

Returns a random secondary address.

## Examples

    iex> Faker.Address.Hy.secondary_address()
    "բն. 1"
    iex> Faker.Address.Hy.secondary_address()
    "բն. 4"
    iex> Faker.Address.Hy.secondary_address()
    "բն. 64"
    iex> Faker.Address.Hy.secondary_address()
    "բն. 110"

# `state`

```elixir
@spec state() :: String.t()
```

Returns state.

## Examples

    iex> Faker.Address.Hy.state()
    "Արագածոտն"
    iex> Faker.Address.Hy.state()
    "Արարատ"
    iex> Faker.Address.Hy.state()
    "Կոտայք"
    iex> Faker.Address.Hy.state()
    "Լոռի"

# `state_abbr`

```elixir
@spec state_abbr() :: String.t()
```

Returns state abbr.

## Examples

    iex> Faker.Address.Hy.state_abbr()
    "ԱԳ"
    iex> Faker.Address.Hy.state_abbr()
    "ԱՐ"
    iex> Faker.Address.Hy.state_abbr()
    "ԿՏ"
    iex> Faker.Address.Hy.state_abbr()
    "ԼՌ"

# `street_address`

```elixir
@spec street_address() :: String.t()
```

Returns street address.

## Examples

    iex> Faker.Address.Hy.street_address()
    "Սուրբ Հովհաննեսի 542"
    iex> Faker.Address.Hy.street_address()
    "Բուռնազյան 61"
    iex> Faker.Address.Hy.street_address()
    "Լամբրոնի 329"
    iex> Faker.Address.Hy.street_address()
    "Հանրապետության 5"

# `street_address`

```elixir
@spec street_address(true | any()) :: String.t()
```

Returns `street_address/0` or if argument is `true` adds `secondary_address/0`.

## Examples

    iex> Faker.Address.Hy.street_address(true)
    "Սուրբ Հովհաննեսի 542 բն. 4"
    iex> Faker.Address.Hy.street_address(false)
    "Գյուլբենկյան 0"
    iex> Faker.Address.Hy.street_address(true)
    "Պուշկինի 29 բն. 0"
    iex> Faker.Address.Hy.street_address(false)
    "Տիգրան Մեծի 35"

# `street_name`

```elixir
@spec street_name() :: String.t()
```

Returns street name.

## Examples

    iex> Faker.Address.Hy.street_name()
    "Սուրբ Հովհաննեսի"
    iex> Faker.Address.Hy.street_name()
    "Մոսկովյան"
    iex> Faker.Address.Hy.street_name()
    "Սերգեյ Փարաջանովի"
    iex> Faker.Address.Hy.street_name()
    "Պրահայի"

# `street_suffix`

```elixir
@spec street_suffix() :: String.t()
```

Returns street suffix.

## Examples

    iex> Faker.Address.Hy.street_suffix()
    "նրբանցք"
    iex> Faker.Address.Hy.street_suffix()
    "պողոտա"
    iex> Faker.Address.Hy.street_suffix()
    "փակուղի"
    iex> Faker.Address.Hy.street_suffix()
    "փողոց"

# `zip_code`

```elixir
@spec zip_code() :: String.t()
```

Returns a random postcode.

## Examples

    iex> Faker.Address.Hy.zip_code()
    "0154"
    iex> Faker.Address.Hy.zip_code()
    "2646"
    iex> Faker.Address.Hy.zip_code()
    "1083"
    iex> Faker.Address.Hy.zip_code()
    "2970"

---

*Consult [api-reference.md](api-reference.md) for complete listing*