holidefs

v0.3.1

holidefs v0.3.1 Holidefs.Definition View Source

A definition is a set of rules for the holiday events in the year.

Link to this section Summary

Types

t()

Functions

file_path(code, path \\ path())

Returns the path for the given locale definition file

get_regions(definition)

Returns the list of regions from the definition

load!(code, name)

Loads the definition for a locale code and name

path()

Returns the path where all the locale definitions are saved

Link to this section Types

Link to this type t() View Source 
t() :: %Holidefs.Definition{
  code: atom(),
  name: String.t(),
  rules: [Holidefs.Definition.Rule.t()]
}

Link to this section Functions

Link to this function file_path(code, path \\ path()) View Source 
file_path(atom(), Path.t()) :: binary()

Returns the path for the given locale definition file

Link to this function get_regions(definition) View Source 
get_regions(t()) :: [String.t()]

Returns the list of regions from the definition.

Link to this function load!(code, name) View Source 
load!(atom(), String.t()) :: t()

Loads the definition for a locale code and name.

If any definition rule is invalid, a RuntimeError will be raised

Link to this function path() View Source 
path() :: Path.t()

Returns the path where all the locale definitions are saved