scriptorium - v1.0.2

scriptorium/utils/date

Types

Date

</>

A date with 1-indexed years and days.

pub type Date {
  Date(year: Int, month: Month, day: Day)
}

Constructors 

  • Date(year: Int, month: Month, day: Day)

Month

</> 
pub type Month {
  Jan
  Feb
  Mar
  Apr
  May
  Jun
  Jul
  Aug
  Sep
  Oct
  Nov
  Dec
}

Constructors 

  • Jan
  • Feb
  • Mar
  • Apr
  • May
  • Jun
  • Jul
  • Aug
  • Sep
  • Oct
  • Nov
  • Dec

Constants

months

</> 
pub const months: List(Month)

All months in order.

Functions

compare

</> 
pub fn compare(a: Date, b: Date) -> Order

Compare if a is before (lower than) b.

days_in_month

</> 
pub fn days_in_month(month: Month, year: Int) -> Int

Get the number of days in a month in a given year.

format

</> 
pub fn format(date: Date) -> String

Format a date in the format “2 Aug 2024”.

format_iso

</> 
pub fn format_iso(date: Date) -> String

Format a date in the ISO 8601 format.

is_valid_date

</> 
pub fn is_valid_date(date: Date) -> Bool

Check if a given date is valid.

month_to_int

</> 
pub fn month_to_int(month: Month) -> Int

Convert a month to a 1-indexed int.

month_to_string

</> 
pub fn month_to_string(month: Month) -> String

Convert a month to an English month name string.

parse_month

</> 
pub fn parse_month(month_int: Int) -> Result(Month, Nil)

Parse an integer into a month.

✨ Search Document