The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Date::Holidays::US - Date::Holidays Adapter for US Federal holidays

SYNOPSIS

  use Date::Holidays::US qw{is_holiday};
  my $holiday_name = is_holiday($year, $month, $day);

DESCRIPTION

Date::Holidays Adapter for US Federal holidays back to 1880 with updates from 2022.

METHODS

is_holiday

Returns a holiday name or undef given three arguments (year, month, day).

  my ($year, $month, $day) = (2022, 6, 19);
  use Date::Holidays::US qw{is_holiday};
  my $holiday_name = is_holiday($year, $month, $day);
  if (defined $holiday_name) {
    print "Holiday: $holiday_name\n";
  } else {
    print "Not a US Holiday\n";
  }

is_us_holiday

Wrapper around is_holiday function per the API specification. See "is_holiday1" in Date::Holidays

holidays

Returns a hash reference containing all of the holidays in specied year. The keys for the returned hash reference are the dates where 2-digit month and 2-digit day are concatenated.

  use Date::Holidays::US qw{holidays};
  my $year          = 2022;
  my $holidays_href = holidays($year);
  foreach my $key (sort keys %$holidays_href) { #e.g. "0101", "0619","0704"
    my ($month, $day) = $key =~ m/\A([0-9]{2})([0-9]{2})\Z/;
    my $name          = $holidays_href->{$key};
    print "Year: $year, Month: $month, Day: $day, Name: $name\n";
  }

us_holidays

Wrapper around holidays function per the API specification. See "holidays1" in Date::Holidays

TODO

Add Federal Holidays for President mark of respect holidays (e.g. 2007-01-02 for Gerald R. Ford, the thirty-eighth President of the United States)

SEE ALSO

Date::Holidays, Date::Holidays::USFederal

AUTHOR

Michael R. Davis, MRDVT

COPYRIGHT AND LICENSE

Copyright (C) 2022 by Michael R. Davis

MIT License