date-fns-holiday-us
The purpose of this project is to give an interface to work with holidays using date-fns
Install
yarn add date-fns-holiday-us date-fns
or with npm:
npm i date-fns-holiday-us date-fns
Table of contents
Type Aliases
Functions
Type Aliases
Holiday
Ƭ Holiday: "christmas"
| "easter"
| "halloween"
| "valentinesDay"
| "mothersDay"
| "columbusDay"
| "independenceDay"
| "presidentsDay"
| "laborDay"
| "veteransDay"
| "thanksgiving"
| "newYearsEve"
| "martinLutherKingJrDay"
| "newYearsDay"
| "fathersDay"
| "memorialDay"
| "goodFriday"
| "juneteenth"
Defined in
index.ts:13
Holidays
Ƭ Holidays: { [K in Holiday]: Object }
Defined in
index.ts:139
Functions
getBankHolidays
▸ getBankHolidays(year
): Object
Parameters
Returns
Object
Defined in
index.ts:242
getChristmas
▸ getChristmas(year
): Date
Parameters
Returns
Date
Defined in
index.ts:99
getColumbusDay
▸ getColumbusDay(year
): Date
Parameters
Returns
Date
Defined in
index.ts:87
getEaster
▸ getEaster(year
): Date
Parameters
Returns
Date
Defined in
index.ts:49
getFathersDay
▸ getFathersDay(year
): Date
Parameters
Returns
Date
Defined in
index.ts:127
getFederalHolidays
▸ getFederalHolidays(year
): Object
Parameters
Returns
Object
Defined in
index.ts:264
getGoodFriday
▸ getGoodFriday(year
): Date
Parameters
Returns
Date
Defined in
index.ts:135
getHalloween
▸ getHalloween(year
): Date
Parameters
Returns
Date
Defined in
index.ts:33
getHolidays
▸ getHolidays(year
): Holidays
Parameters
Returns
Holidays
Defined in
index.ts:147
getIndependenceDay
▸ getIndependenceDay(year
): Date
Parameters
Returns
Date
Defined in
index.ts:91
getJuneteenth
▸ getJuneteenth(year
): Date
Parameters
Returns
Date
Defined in
index.ts:45
getLaborDay
▸ getLaborDay(year
): Date
Parameters
Returns
Date
Defined in
index.ts:103
getMartinLutherKingJrDay
▸ getMartinLutherKingJrDay(year
): Date
Parameters
Returns
Date
Defined in
index.ts:119
getMemorialDay
▸ getMemorialDay(year
): Date
Parameters
Returns
Date
Defined in
index.ts:131
getMothersDay
▸ getMothersDay(year
): Date
Parameters
Returns
Date
Defined in
index.ts:41
getNewYearsDay
▸ getNewYearsDay(year
): Date
Parameters
Returns
Date
Defined in
index.ts:123
getNewYearsEve
▸ getNewYearsEve(year
): Date
Parameters
Returns
Date
Defined in
index.ts:115
getObservedHolidays
▸ getObservedHolidays(year
): Record
<string
, Record
<"date"
, Date
>>
Parameters
Returns
Record
<string
, Record
<"date"
, Date
>>
Defined in
index.ts:286
getPresidentsDay
▸ getPresidentsDay(year
): Date
Parameters
Returns
Date
Defined in
index.ts:95
getThanksgiving
▸ getThanksgiving(year
): Date
Parameters
Returns
Date
Defined in
index.ts:111
getValentinesDay
▸ getValentinesDay(year
): Date
Parameters
Returns
Date
Defined in
index.ts:37
getVeteransDay
▸ getVeteransDay(year
): Date
Parameters
Returns
Date
Defined in
index.ts:107
isBankHoliday
▸ isBankHoliday(date
): boolean
Parameters
Returns
boolean
Defined in
index.ts:339
isFederalHoliday
▸ isFederalHoliday(date
): boolean
Parameters
Returns
boolean
Defined in
index.ts:335
isHoliday
▸ isHoliday(date
): boolean
Parameters
Returns
boolean
Defined in
index.ts:331
isInHolidayList
▸ isInHolidayList(date
, getHolidayList
): boolean
Parameters
Name | Type |
---|
date | Date |
getHolidayList | (year : number ) => { [key: string] : { date : Date }; } |
Returns
boolean
Defined in
index.ts:319
© 2020 Jon Stuebe