@hebcal/core 5.6.0 → 5.7.0

package/README.md

@@ -1,4 +1,5 @@
 # @hebcal/core
+
 Hebcal is a perpetual Jewish Calendar. This library converts between
 Hebrew and Gregorian dates, and generates lists of Jewish holidays for
 any year (past, present or future).  Shabbat and holiday candle
@@ -20,11 +21,31 @@ Many users of this library will utilize the [HebrewCalendar](https://hebcal.gith
 and [HDate](https://hebcal.github.io/api/hdate/classes/HDate.html) interfaces.
 
 ## Installation
+
 ```bash
-$ npm install @hebcal/core
+npm install @hebcal/core
 ```
 
+## Usage
+
+This package exports 3 categories of output:
+
+- `dist/bundle.min.js`: This includes all dependencies in a single JS file.  It's quite large (174KB minified), and should only be used if you aren't using a bundler.
+- `dist/index.cjs`: This includes all of this package's code in a single bundle.
+- `dist/es/`: This directory contains ES modules for each source file in the package.  If you're using Rollup, Vite, or another bundler, you should import from here to reduce output sizes.
+  - These files do not include polyfills; if you want to support older browsers, use <https://github.com/rollup/plugins/tree/master/packages/babel#babelhelpers>
+  - To make tree-shaking work better, import from the most specific file possible; avoid importing from `index` or `hebcal`.  Some APIs may still need to be moved to specific files.  For example:
+
+    ```ts
+    import {getHolidaysOnDate} from '@hebcal/core/dist/es/holidays';
+    ```
+
+  - This can save hundreds of kilobytes by dropping Zmanim dependencies if your code doesn't use them.
+
+  - You will need to include `@rollup/plugin-node-resolve` in your Rollup config.
+
 ## Synopsis
+
 ```javascript
 import {HebrewCalendar, HDate, Location, Event} from '@hebcal/core';
 
@@ -44,4 +65,5 @@ for (const ev of events) {
   console.log(date.toLocaleDateString(), ev.render('en'), hd.toString());
 }
 ```
+
 ## [API Documentation](https://hebcal.github.io/api/core/index.html)

package/dist/CalOptions.d.ts

@@ -1,5 +1,5 @@
 import { HDate } from '@hebcal/hdate';
-import { Location } from './location';
+import type { Location } from './location';
 export type DailyLearningValue = boolean | number | string;
 /**
  * Options to configure which events are returned

package/dist/HolidayEvent.d.ts

@@ -1,6 +1,5 @@
 import { HDate } from '@hebcal/hdate';
 import { Event } from './event';
-import { TimedEvent } from './TimedEvent';
 import './locale';
 /** Represents a built-in holiday like Pesach, Purim or Tu BiShvat */
 export declare class HolidayEvent extends Event {
@@ -13,10 +12,6 @@ export declare class HolidayEvent extends Event {
      * - Tzom Tammuz postponed from the 17th to the 18th
      */
     observed?: boolean;
-    /** For a Fast day, this will be a "Fast begins" event */
-    startEvent?: TimedEvent;
-    /** For a Fast day, this will be a "Fast ends" event */
-    endEvent?: TimedEvent;
     basename(): string;
     url(): string | undefined;
     urlDateSuffix(): string;

package/dist/YomKippurKatanEvent.d.ts

@@ -1,7 +1,6 @@
 import { HDate } from '@hebcal/hdate';
 import { HolidayEvent } from './HolidayEvent';
 import './locale';
-export declare const ykk = "Yom Kippur Katan";
 /** YKK is minor day of atonement on the day preceeding each Rosh Chodesh */
 export declare class YomKippurKatanEvent extends HolidayEvent {
     private readonly nextMonthName;