date-fns-holiday-us

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

API

Type aliases

• Holiday
• Holidays

Functions

• getBankHolidays
• getChristmas
• getColumbusDay
• getEaster
• getFathersDay
• getFirstOccurence
• getGoodFriday
• getHalloween
• getHolidays
• getIndependenceDay
• getJuneteenth
• getLaborDay
• getLastOfMonth
• getMartinLutherKingJrDay
• getMemorialDay
• getMothersDay
• getNewYearsDay
• getNewYearsEve
• getNextOccurence
• getObservedHolidays
• getPresidentsDay
• getPrevOccurence
• getThanksgiving
• getValentinesDay
• getVeteransDay
• isBankHoliday
• isHoliday
• isInHolidayList

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: object

Defined in index.ts:139

Type declaration:

Functions

getBankHolidays

▸ getBankHolidays(year: number): object

Defined in index.ts:242

Parameters:

Name	Type
year	number

Returns: object

• [ key: string]: object

• date: Date

---

getChristmas

▸ getChristmas(year: number): Date

Defined in index.ts:99

Parameters:

Name	Type
year	number

Returns: Date

---

getColumbusDay

▸ getColumbusDay(year: number): Date

Defined in index.ts:87

Parameters:

Name	Type
year	number

Returns: Date

---

getEaster

▸ getEaster(year: number): Date

Defined in index.ts:49

Parameters:

Name	Type
year	number

Returns: Date

---

getFathersDay

▸ getFathersDay(year: number): Date

Defined in index.ts:127

Parameters:

Name	Type
year	number

Returns: Date

---

getFirstOccurence

▸ getFirstOccurence(date: Date, dayOfWeekIndex: number): Date

Defined in utils.ts:8

Parameters:

Name	Type
date	Date
dayOfWeekIndex	number

Returns: Date

---

getGoodFriday

▸ getGoodFriday(year: number): Date

Defined in index.ts:135

Parameters:

Name	Type
year	number

Returns: Date

---

getHalloween

▸ getHalloween(year: number): Date

Defined in index.ts:33

Parameters:

Name	Type
year	number

Returns: Date

---

getHolidays

▸ getHolidays(year: number): Holidays

Defined in index.ts:147

Parameters:

Name	Type
year	number

Returns: Holidays

---

getIndependenceDay

▸ getIndependenceDay(year: number): Date

Defined in index.ts:91

Parameters:

Name	Type
year	number

Returns: Date

---

getJuneteenth

▸ getJuneteenth(year: number): Date

Defined in index.ts:45

Parameters:

Name	Type
year	number

Returns: Date

---

getLaborDay

▸ getLaborDay(year: number): Date

Defined in index.ts:103

Parameters:

Name	Type
year	number

Returns: Date

---

getLastOfMonth

▸ getLastOfMonth(date: Date, dayOfWeekIndex: number): Date

Defined in utils.ts:38

Parameters:

Name	Type
date	Date
dayOfWeekIndex	number

Returns: Date

---

getMartinLutherKingJrDay

▸ getMartinLutherKingJrDay(year: number): Date

Defined in index.ts:119

Parameters:

Name	Type
year	number

Returns: Date

---

getMemorialDay

▸ getMemorialDay(year: number): Date

Defined in index.ts:131

Parameters:

Name	Type
year	number

Returns: Date

---

getMothersDay

▸ getMothersDay(year: number): Date

Defined in index.ts:41

Parameters:

Name	Type
year	number

Returns: Date

---

getNewYearsDay

▸ getNewYearsDay(year: number): Date

Defined in index.ts:123

Parameters:

Name	Type
year	number

Returns: Date

---

getNewYearsEve

▸ getNewYearsEve(year: number): Date

Defined in index.ts:115

Parameters:

Name	Type
year	number

Returns: Date

---

getNextOccurence

▸ getNextOccurence(date: Date, dayOfWeekIndex: number): Date

Defined in utils.ts:12

Parameters:

Name	Type
date	Date
dayOfWeekIndex	number

Returns: Date

---

getObservedHolidays

▸ getObservedHolidays(year: number): Record‹string, Record‹"date", Date››

Defined in index.ts:266

Parameters:

Name	Type
year	number

Returns: Record‹string, Record‹"date", Date››

---

getPresidentsDay

▸ getPresidentsDay(year: number): Date

Defined in index.ts:95

Parameters:

Name	Type
year	number

Returns: Date

---

getPrevOccurence

▸ getPrevOccurence(date: Date, dayOfWeekIndex: number): Date

Defined in utils.ts:25

Parameters:

Name	Type
date	Date
dayOfWeekIndex	number

Returns: Date

---

getThanksgiving

▸ getThanksgiving(year: number): Date

Defined in index.ts:111

Parameters:

Name	Type
year	number

Returns: Date

---

getValentinesDay

▸ getValentinesDay(year: number): Date

Defined in index.ts:37

Parameters:

Name	Type
year	number

Returns: Date

---

getVeteransDay

▸ getVeteransDay(year: number): Date

Defined in index.ts:107

Parameters:

Name	Type
year	number

Returns: Date

---

isBankHoliday

▸ isBankHoliday(date: Date): boolean

Defined in index.ts:315

Parameters:

Name	Type
date	Date

Returns: boolean

---

isHoliday

▸ isHoliday(date: Date): boolean

Defined in index.ts:311

Parameters:

Name	Type
date	Date

Returns: boolean

---

isInHolidayList

▸ isInHolidayList(date: Date, getHolidayList: function): boolean

Defined in index.ts:299

Parameters:

▪ date: Date

▪ getHolidayList: function

▸ (year: number): object

Parameters:

Name	Type
year	number

• [ key: string]: object

• date: Date

Returns: boolean

© 2020 Jon Stuebe