JSCalendar.NDay (JSCalendar v0.1.0)

Copy Markdown View Source

A weekday within a recurrence, optionally counted from the start or end of the period (RFC 8984 §4.3.3).

nth_of_period: -1 with day: "mo" is "the last Monday".

Summary

Types

t()

Functions

from_map(map)

Read this object from a decoded JSON map.

jscalendar_type()

The @type value RFC 8984 gives this object.

to_map(object)

Write this object back to a JSON-ready map.

Types

t()

@type t() :: %JSCalendar.NDay{
  day: String.t() | nil,
  extra: map(),
  nth_of_period: integer() | nil
}

Functions

from_map(map)

@spec from_map(map()) :: {:ok, struct()} | {:error, term()}

Read this object from a decoded JSON map.

Arguments

Returns

  • {:ok, object}; or

  • {:error, reason} when a property does not match its declared type.

jscalendar_type()

@spec jscalendar_type() :: String.t()

The @type value RFC 8984 gives this object.

Returns

  • the type name as a string.

to_map(object)

@spec to_map(struct()) :: map()

Write this object back to a JSON-ready map.

Arguments

  • object is a t/0.

Returns