New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

us-holidays-helper

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

us-holidays-helper

The purpose of this project is to give an interface to work with holidays using date-fns

1.4.0
latest
Source
npm
Version published
Weekly downloads
2.6K
21.37%
Maintainers
1
Weekly downloads
 
Created
Source

us-holidays-helper

The purpose of this project is to give an interface to work with holidays using date-fns

Install

npm i us-holidays-helper   

Table of contents

Type Aliases

  • Holiday
  • Holidays

Functions

Type Aliases

Holiday

Ƭ Holiday: "christmas" | "easter" | "halloween" | "valentinesDay" | "mothersDay" | "indigenousPeoplesDay" | "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
NameType
yearnumber
Returns

Object

Defined in

index.ts:242

getChristmas

getChristmas(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:99

getEaster

getEaster(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:49

getFathersDay

getFathersDay(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:127

getFederalHolidays

getFederalHolidays(year): Object

Parameters
NameType
yearnumber
Returns

Object

Defined in

index.ts:264

getGoodFriday

getGoodFriday(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:135

getHalloween

getHalloween(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:33

getHolidays

getHolidays(year): Holidays

Parameters
NameType
yearnumber
Returns

Holidays

Defined in

index.ts:147

getIndependenceDay

getIndependenceDay(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:91

getIndigenousPeoplesDay

getIndigenousPeoplesDay(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:87

getJuneteenth

getJuneteenth(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:45

getLaborDay

getLaborDay(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:103

getMartinLutherKingJrDay

getMartinLutherKingJrDay(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:119

getMemorialDay

getMemorialDay(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:131

getMothersDay

getMothersDay(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:41

getNewYearsDay

getNewYearsDay(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:123

getNewYearsEve

getNewYearsEve(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:115

getObservedHolidays

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

Parameters
NameType
yearnumber
Returns

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

Defined in

index.ts:286

getPresidentsDay

getPresidentsDay(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:95

getThanksgiving

getThanksgiving(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:111

getValentinesDay

getValentinesDay(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:37

getVeteransDay

getVeteransDay(year): Date

Parameters
NameType
yearnumber
Returns

Date

Defined in

index.ts:107

isBankHoliday

isBankHoliday(date): boolean

Parameters
NameType
dateDate
Returns

boolean

Defined in

index.ts:339

isDateAHoliday

isDateAHoliday(date, holidaysToInclude): boolean

Parameters
NameType
dateDate
holidaysToIncludeHoliday[]
Returns

boolean

Defined in

index.ts:343

isFederalHoliday

isFederalHoliday(date): boolean

Parameters
NameType
dateDate
Returns

boolean

Defined in

index.ts:335

isHoliday

isHoliday(date): boolean

Parameters
NameType
dateDate
Returns

boolean

Defined in

index.ts:331

isInHolidayList

isInHolidayList(date, getHolidayList): boolean

Parameters
NameType
dateDate
getHolidayList(year: number) => { [key: string]: { date: Date }; }
Returns

boolean

Defined in

index.ts:319

Keywords

date-fns

FAQs

Package last updated on 25 Mar 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts