README.md

Cldr Time Zone Names

A plugin for ex_cldr that packages time zone name definitions.

Installation

Add ex_cldr_time_zone_names to your list of dependencies in mix.exs:

def deps do
  [
    {:ex_cldr_time_zone_names, "~> 0.1.0"}
  ]
end

Then, add the plugin to your CLDR backend:

defmodule MyApp.Cldr do
  use Cldr,
    providers: [
      Cldr.TimeZoneName,
      # ...
    ],
    # ...
end

Usage

This plugin provides functions for looking up time zone name data for a given IANA time zone name and meta zone name (e.g. America_Central).

# Look up the name information for US Central Time in English
iex> MyApp.Cldr.TimeZoneName.resolve("America/Chicago", "america_central", locale: :en)
{:ok,
 %Cldr.TimeZoneName.Info{
   exemplar_city: "Chicago",
   long: %Cldr.TimeZoneName.Variants{
     daylight: "Central Daylight Time",
     generic: "Central Time",
     standard: "Central Standard Time"
   },
   short: %Cldr.TimeZoneName.Variants{
     daylight: "CDT",
     generic: "CT",
     standard: "CST"
   }
 }}