View Source Holidefs.Definition (holidefs v0.4.0)

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

Link to this section Summary

t()

Returns the path for the given locale definition file.

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.

t() :: %Holidefs.Definition{
  code: atom(),
  name: String.t(),
  rules: [Holidefs.Definition.Rule.t()]
}

file_path(atom(), Path.t()) :: binary()

Returns the path for the given locale definition file.

get_regions(t()) :: [String.t()]

Returns the list of regions from the definition.

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

path() :: Path.t()

Returns the path where all the locale definitions are saved.