@hebcal/core 5.9.2 → 5.9.4

package/dist/omer.d.ts

@@ -1,6 +1,11 @@
 import { HDate } from '@hebcal/hdate';
 import { Event } from './event';
 import './locale';
+/**
+ * Language for counting the Omer can be English or Hebrew.
+ * Lang for the Sefira can be English, Hebrew, or Hebrew in Sephardic transliteration.
+ */
+export type OmerLang = 'en' | 'he' | 'translit';
 /** Represents a day 1-49 of counting the Omer from Pesach to Shavuot */
 export declare class OmerEvent extends Event {
     private readonly weekNumber;
@@ -13,11 +18,15 @@ export declare class OmerEvent extends Event {
      */
     constructor(date: HDate, omerDay: number);
     /**
-     * @param lang
+     * Returns the sefira. For example, on day 8:
+     *  * חֶֽסֶד שֶׁבִּגְבוּרָה
+     *  * Chesed shebiGevurah
+     *  * Lovingkindness within Might
+     * @param lang `en` (English), `he` (Hebrew with nikud), or `translit` (Hebrew in Sephardic transliteration)
+     * @returns a string such as `Lovingkindness within Might` or `חֶֽסֶד שֶׁבִּגְבוּרָה`
      */
-    sefira(lang?: string): string;
+    sefira(lang?: OmerLang): string;
     /**
-     * @todo use gettext()
      * @param [locale] Optional locale name (defaults to active locale).
      */
     render(locale?: string): string;
@@ -26,11 +35,19 @@ export declare class OmerEvent extends Event {
      * @param [locale] Optional locale name (defaults to active locale).
      */
     renderBrief(locale?: string): string;
+    /**
+     * Returns an emoji number symbol with a circle, for example `㊲`
+     *  from the “Enclosed CJK Letters and Months” block of the Unicode standard
+     * @param omerDay the day of the omer, 1-49 inclusive
+     * @returns a single Unicode character from `①` through `㊾`
+     */
     getEmoji(): string;
     getWeeks(): number;
     getDaysWithinWeeks(): number;
     /**
-     * @param locale
+     * Returns a sentence with that evening's omer count
+     * @returns a string such as `Today is 10 days, which is 1 week and 3 days of the Omer`
+     *  or `הַיוֹם עֲשָׂרָה יָמִים, שְׁהֵם שָׁבוּעַ אֶחָד וְשְׁלוֹשָׁה יָמִים לָעוֹמֶר`
      */
     getTodayIs(locale: string): string;
     url(): string;

package/dist/pkgVersion.d.ts

@@ -1,2 +1,2 @@
 /** DO NOT EDIT THIS AUTO-GENERATED FILE! */
-export declare const version = "5.9.2";
+export declare const version = "5.9.4";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hebcal/core",
-  "version": "5.9.2",
+  "version": "5.9.4",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
   "contributors": [
     "Eyal Schachter (https://github.com/Scimonster)",
@@ -67,32 +67,32 @@
   },
   "license": "GPL-2.0",
   "devDependencies": {
-    "@babel/core": "^7.26.10",
-    "@babel/plugin-transform-runtime": "^7.26.10",
-    "@babel/preset-env": "^7.26.9",
-    "@babel/preset-typescript": "^7.27.0",
-    "@babel/register": "^7.25.9",
+    "@babel/core": "^7.27.1",
+    "@babel/plugin-transform-runtime": "^7.27.1",
+    "@babel/preset-env": "^7.27.1",
+    "@babel/preset-typescript": "^7.27.1",
+    "@babel/register": "^7.27.1",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-commonjs": "^28.0.3",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.1",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^12.1.2",
-    "@types/node": "^22.13.14",
-    "@vitest/coverage-v8": "^3.0.9",
-    "core-js": "^3.41.0",
+    "@types/node": "^22.15.3",
+    "@vitest/coverage-v8": "^3.1.2",
+    "core-js": "^3.42.0",
     "gettext-parser": "^8.0.0",
     "gts": "^6.0.2",
-    "pretty-bytes": "^6.1.1",
-    "rollup": "^4.37.0",
+    "pretty-bytes": "^7.0.0",
+    "rollup": "^4.40.1",
     "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-visualizer": "^5.14.0",
-    "typedoc": "^0.28.1",
-    "typescript": "^5.8.2",
-    "vitest": "^3.0.9"
+    "typedoc": "^0.28.3",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.2"
   },
   "dependencies": {
-    "@hebcal/hdate": "^0.13.6",
+    "@hebcal/hdate": "^0.14.0",
     "@hebcal/noaa": "^0.9.1",
     "quick-lru": "^6.1.2",
     "temporal-polyfill": "^0.3.0",