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

• Holiday
• Holidays

Functions

• getBankHolidays
• getBlackFriday
• getChristmasDay
• getChristmasEve
• getColumbusDay
• getEaster
• getFathersDay
• getFederalHolidays
• getGoodFriday
• getHalloween
• getHolidays
• getIndependenceDay
• getJuneteenth
• getLaborDay
• getMartinLutherKingJrDay
• getMemorialDay
• getMothersDay
• getNewYearsDay
• getNewYearsEve
• getObservedHolidays
• getPresidentsDay
• getThanksgiving
• getValentinesDay
• getVeteransDay
• isBankHoliday
• isFederalHoliday
• isHoliday
• isInHolidayList

Type Aliases

Holiday

Ƭ Holiday: "blackFriday" | "christmasDay" | "christmasEve" | "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:149

Functions

getBankHolidays

▸ getBankHolidays(year): Object

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Object

Defined in

index.ts:262

getBlackFriday

▸ getBlackFriday(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:35

getChristmasDay

▸ getChristmasDay(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:105

getChristmasEve

▸ getChristmasEve(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:109

getColumbusDay

▸ getColumbusDay(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:93

getEaster

▸ getEaster(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:55

getFathersDay

▸ getFathersDay(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:137

getFederalHolidays

▸ getFederalHolidays(year): Object

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Object

Defined in

index.ts:284

getGoodFriday

▸ getGoodFriday(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:145

getHalloween

▸ getHalloween(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:39

getHolidays

▸ getHolidays(year): Holidays

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Holidays

Defined in

index.ts:157

getIndependenceDay

▸ getIndependenceDay(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:97

getJuneteenth

▸ getJuneteenth(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:51

getLaborDay

▸ getLaborDay(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:113

getMartinLutherKingJrDay

▸ getMartinLutherKingJrDay(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:129

getMemorialDay

▸ getMemorialDay(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:141

getMothersDay

▸ getMothersDay(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:47

getNewYearsDay

▸ getNewYearsDay(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:133

getNewYearsEve

▸ getNewYearsEve(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:125

getObservedHolidays

▸ getObservedHolidays(year): Record<string, Record<"date", Date>>

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Record<string, Record<"date", Date>>

Defined in

index.ts:306

getPresidentsDay

▸ getPresidentsDay(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:101

getThanksgiving

▸ getThanksgiving(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:121

getValentinesDay

▸ getValentinesDay(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:43

getVeteransDay

▸ getVeteransDay(year): Date

Parameters

| Name | Type | | :------ | :------ | | year | number |

Returns

Date

Defined in

index.ts:117

isBankHoliday

▸ isBankHoliday(date): boolean

Parameters

| Name | Type | | :------ | :------ | | date | Date |

Returns

boolean

Defined in

index.ts:359

isFederalHoliday

▸ isFederalHoliday(date): boolean

Parameters

| Name | Type | | :------ | :------ | | date | Date |

Returns

boolean

Defined in

index.ts:355

isHoliday

▸ isHoliday(date): boolean

Parameters

| Name | Type | | :------ | :------ | | date | Date |

Returns

boolean

Defined in

index.ts:351

isInHolidayList

▸ isInHolidayList(date, getHolidayList): boolean

Parameters

| Name | Type | | :------ | :------ | | date | Date | | getHolidayList | (year: number) => { [key: string]: { date: Date }; } |

Returns

boolean

Defined in

index.ts:339

© 2020 Jon Stuebe