holidefs v0.4.0

View Source Holidefs.Definition.Rule (holidefs v0.4.0)

A definition rule has the information about the event and when it happens on a year.

Link to this section Summary

Types

t()

Functions

build(code, month, map)

Builds a new rule from its month and definition map

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %Holidefs.Definition.Rule{
  day: integer(),
  function: atom() | nil,
  function_modifier: integer() | nil,
  informal?: boolean(),
  month: integer(),
  name: String.t(),
  observed: atom() | nil,
  regions: [String.t()],
  week: integer(),
  weekday: integer(),
  year_ranges: map() | nil
}

Link to this section Functions

Link to this function

build(code, month, map)

View Source

Specs

build(atom(), integer(), map()) :: t()

Builds a new rule from its month and definition map