Class DailyLearning

Plug-ins for daily learning calendars such as Daf Yomi, Mishna Yomi, Nach Yomi, etc.

Learning schedules are provided by the @hebcal/learning package.

Index

Constructors

Methods

addCalendar getCalendars getStartDate has lookup

Constructors

constructor

new DailyLearning(): DailyLearning
Returns DailyLearning

Methods

`Static`addCalendar

addCalendar(
    name: string,
    calendar: (hd: HDate, il: boolean) => Event | null,
    startDate?: HDate,
): void
Register a new learning calendar.
Parameters
- name: string
  case insensitive
- calendar: (hd: HDate, il: boolean) => Event | null
  a function that returns an Event or null
- OptionalstartDate: HDate
  the first date for which this calendar is valid
Returns void
- Defined in src/DailyLearning.ts:22

`Static`getCalendars

getCalendars(): string[]
Returns the names of all calendars registered

Returns string[]
- Defined in src/DailyLearning.ts:68

`Static`getStartDate

getStartDate(name: string): HDate | undefined
Parameters
- name: string
Returns HDate | undefined
- Defined in src/DailyLearning.ts:51

`Static`has

has(name: string): boolean
Tests to see if learning calendar has been registered
Parameters
- name: string
  case insensitive
Returns boolean
- Defined in src/DailyLearning.ts:63

`Static`lookup

lookup(name: string, hd: HDate, il: boolean): Event | null
Returns an event from daily calendar for a given date. Returns null if there is no learning from this calendar on this date.
Parameters
- name: string
  case insensitive
- hd: HDate
  Hebrew Date
- il: boolean
  true for Israel, false for Diaspora
Returns Event | null
- Defined in src/DailyLearning.ts:43