Packages

tz

0.3.0
0.28.2 0.28.1 0.28.0 0.27.3 0.27.2 0.27.1 0.27.0 0.26.6 0.26.5 0.26.4 0.26.3 0.26.2 0.26.1 0.26.0 0.25.1 0.25.0 0.24.0 0.23.0 0.22.0 0.21.1 0.21.0 0.20.1 0.20.0 0.19.0 0.17.0 0.16.2 0.16.1 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.2 0.8.1 0.8.0 0.7.3 0.7.2 0.7.1 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

Time zone support for Elixir

HexDocs

Current section

Files

Jump to
Readme
48 Versions
0 Dependencies
Dependants
Files
Activity
tz README.md
Raw

README.md 

# Tz



Time zone support for Elixir.



The Elixir standard library does not ship with a time zone database. As a result, the functions in the `DateTime`

module can, by default, only operate on datetimes in the UTC time zone. Alternatively (and

[deliberately](https://elixirforum.com/t/14743)), the standard library relies on

third-party libraries, such as `tz`, to bring in time zone support and deal with datetimes in other time zones than UTC.



The `tz` library relies on the [time zone database](https://data.iana.org/time-zones/tzdb/) maintained by

[IANA](https://www.iana.org). As of version 0.3.0, `tz` uses version _tzdata2019c_ of the IANA time zone database.



## Usage



To use the `tz` database, either configure it via configuration:

```

config :elixir, :time_zone_database, Tz.TimeZoneDatabase

```



or by calling `Calendar.put_time_zone_database/1`:

```

Calendar.put_time_zone_database(Tz.TimeZoneDatabase)

```



or by passing the module name `Tz.TimeZoneDatabase` directly to the functions that need a time zone database:

```

DateTime.now("America/Sao_Paulo", Tz.TimeZoneDatabase)

```



Refer to the [DateTime API](https://hexdocs.pm/elixir/DateTime.html#module-time-zone-database) for more details

about handling datetimes with time zones.



## Installation



Add `tz` for Elixir as a dependency in your `mix.exs` file:



```elixir

def deps do

  [

    {:tz, "~> 0.3.0"}

  ]

end

```



## HexDocs



HexDocs documentation can be found at [https://hexdocs.pm/tz](https://hexdocs.pm/tz).