@hebcal/core 6.9.3 → 6.11.0

package/README.md

@@ -63,15 +63,16 @@ detail — `HolidayEvent`, `ParshaEvent`, `OmerEvent`, `CandleLightingEvent` and
 `HavdalahEvent` (both `TimedEvent`s, carrying an `eventTime`), `MoladEvent`,
 `HebrewDateEvent`, and others.
 
-Rather than testing `instanceof`, classify events with `flags`:
+Rather than testing `instanceof`, classify events by their [`flags`](https://hebcal.github.io/api/core/variables/flags.html)
+using `hasFlag()` (or `flagNames()` to list them all):
 
 ```javascript
-import {calendar, flags} from '@hebcal/core';
+import {calendar} from '@hebcal/core';
 
 const events = calendar({year: 5784, isHebrewYear: true});
 
 for (const ev of events) {
-  if (ev.getFlags() & flags.MAJOR_FAST) {
+  if (ev.hasFlag('MAJOR_FAST')) {
     console.log('fast day:', ev.render('en'));
   }
 }
@@ -133,7 +134,7 @@ Import `@hebcal/learning` once for its side effects, then request calendars thro
 
 ```javascript
 import '@hebcal/learning';
-import {calendar, flags} from '@hebcal/core';
+import {calendar} from '@hebcal/core';
 
 const events = calendar({
   year: 5784,
@@ -143,7 +144,7 @@ const events = calendar({
 });
 
 for (const ev of events) {
-  if (ev.getFlags() & flags.DAF_YOMI) {
+  if (ev.hasFlag('DAF_YOMI')) {
     console.log(ev.getDate().toString(), ev.render('en'));
   }
 }
@@ -186,7 +187,7 @@ and note that coordinates above the Arctic or below the Antarctic circle are
 guaranteed to be wrong.
 
 ```javascript
-import {calendar, Location, flags} from '@hebcal/core';
+import {calendar, Location} from '@hebcal/core';
 
 const events = calendar({
   year: 2024,
@@ -195,7 +196,7 @@ const events = calendar({
 });
 
 for (const ev of events) {
-  if (ev.getFlags() & flags.LIGHT_CANDLES) {
+  if (ev.hasFlag('LIGHT_CANDLES')) {
     console.log(ev.getDate().toString(), ev.eventTimeStr); // '24 Tevet 5784' '16:08'
   }
 }
@@ -215,13 +216,21 @@ visible — calculated at 8.5° of solar depression. Two mutually exclusive over
 
 **Minor fasts** begin at Alot HaShachar (16.1° in the morning). They end at 7.083°
 in the Diaspora, or 15 minutes after sunset in Israel (Rabbi Deblitzky's practice).
-Override with `options.fastEndDeg` or `options.fastEndMins` — again mutually
-exclusive. When a minor fast falls on a Friday, the end time is suppressed, because
+Each end has a pair of mutually exclusive overrides:
+
+- `options.fastStartDeg` — a different solar depression angle for the start, or
+  `options.fastStartMins` — a fixed number of minutes before sunrise (72 and 90
+  are typical).
+- `options.fastEndDeg` — a different solar depression angle for the end, or
+  `options.fastEndMins` — a fixed number of minutes after sunset.
+
+When a minor fast falls on a Friday, the end time is suppressed, because
 Shabbat begins before nightfall.
 
-**Tish'a B'Av** does not follow those rules: it begins at sunset the previous day and
-always ends at 6.45° (Rabbi Yechiel Michel Tucazinsky), ignoring `fastEndDeg` and
-`fastEndMins`.
+**Tish'a B'Av** does not follow those rules: it always begins at sunset the
+previous day, and by default ends at 6.45° (Rabbi Yechiel Michel Tucazinsky),
+ignoring the minor fast options. Override its end with `options.tishaBavEndDeg` or
+`options.tishaBavEndMins` (mutually exclusive).
 
 **Chanukah** candle-lighting, also generated when `candlelighting` and `location`
 are set, is at Bein HaShmashos (13.5 minutes before 7.083°) on weekdays, regular