Class WeekendCalendar

A calendar where specific days of the week are considered holidays.

Hierarchy

Calendar
- WeekendCalendar
  - HolidayCalendar

Index

Constructors

constructor

Accessors

name

Methods

Constructors

constructor

new WeekendCalendar(name?: string, weekends?: number[]): WeekendCalendar

Overrides Calendar.constructor
- Defined in WeekendCalendar.ts:20
Construct a weekend calendar.

Parameters
- name: string = 'WeekendCalendar'
  
  An optional calendar name.
- weekends: number[] = ...
  
  An optional array of week days. Defaults to [0, 6] for Saturday and Sunday.
Returns WeekendCalendar

Accessors

name

get name(): string

Inherited from Calendar.name
- Defined in Calendar.ts:58
Get the calendar name.

Returns string

Methods

isHoliday

isHoliday(dateTz: DateTz): boolean

Overrides Calendar.isHoliday
- Defined in WeekendCalendar.ts:42
Check if the date is a holiday.

Parameters
- dateTz: DateTz
Returns boolean
True if the date is a holiday, otherwise false.

isWeekend

isWeekend(dateTz: DateTz): boolean

- Defined in WeekendCalendar.ts:31
Check if the date is a weekend.

Parameters
- dateTz: DateTz
Returns boolean
True is the date is a weekend, otherwise false.

Generated using TypeDoc