@hebcal/rest-api - npm Package Compare versions

Comparing version 3.13.2 to 3.14.0

dist/index.js

@@ -1,2 +0,2 @@
-/*! @hebcal/rest-api v3.13.2 */
+/*! @hebcal/rest-api v3.14.0 */
 'use strict';
@@ -31,3 +31,33 @@
 
+var AD="Andorra";var AE="United Arab Emirates";var AF="Afghanistan";var AI="Anguilla";var AL="Albania";var AM="Armenia";var AO="Angola";var AR="Argentina";var AS="American Samoa";var AT="Austria";var AU="Australia";var AW="Aruba";var AZ="Azerbaijan";var BA="Bosnia and Herzegovina";var BB="Barbados";var BD="Bangladesh";var BE="Belgium";var BF="Burkina Faso";var BG="Bulgaria";var BH="Bahrain";var BI="Burundi";var BJ="Benin";var BM="Bermuda";var BN="Brunei";var BO="Bolivia";var BR="Brazil";var BS="Bahamas";var BT="Bhutan";var BW="Botswana";var BY="Belarus";var BZ="Belize";var CA="Canada";var CD="Democratic Republic of the Congo";var CF="Central African Republic";var CG="Republic of the Congo";var CH="Switzerland";var CI="Ivory Coast";var CK="Cook Islands";var CL="Chile";var CM="Cameroon";var CN="China";var CO="Colombia";var CR="Costa Rica";var CU="Cuba";var CV="Cape Verde";var CW="Curacao";var CY="Cyprus";var CZ="Czech Republic";var DE="Germany";var DK="Denmark";var DM="Dominica";var DO="Dominican Republic";var DZ="Algeria";var EC="Ecuador";var EE="Estonia";var EG="Egypt";var ER="Eritrea";var ES="Spain";var ET="Ethiopia";var FI="Finland";var FJ="Fiji";var FK="Falkland Islands";var FO="Faroe Islands";var FR="France";var GA="Gabon";var GB="United Kingdom";var GE="Georgia";var GH="Ghana";var GI="Gibraltar";var GL="Greenland";var GM="Gambia";var GN="Guinea";var GQ="Equatorial Guinea";var GR="Greece";var GT="Guatemala";var GW="Guinea-Bissau";var GY="Guyana";var HK="Hong Kong";var HN="Honduras";var HR="Croatia";var HT="Haiti";var HU="Hungary";var ID="Indonesia";var IE="Ireland";var IL="Israel";var IM="Isle of Man";var IN="India";var IQ="Iraq";var IR="Iran";var IS="Iceland";var IT="Italy";var JM="Jamaica";var JO="Jordan";var JP="Japan";var KE="Kenya";var KG="Kyrgyzstan";var KH="Cambodia";var KM="Comoros";var KN="Saint Kitts and Nevis";var KP="North Korea";var KR="South Korea";var KW="Kuwait";var KY="Cayman Islands";var KZ="Kazakhstan";var LA="Laos";var LB="Lebanon";var LC="Saint Lucia";var LI="Liechtenstein";var LR="Liberia";var LS="Lesotho";var LT="Lithuania";var LU="Luxembourg";var LV="Latvia";var LY="Libya";var MA="Morocco";var MD="Moldova";var ME="Montenegro";var MG="Madagascar";var MK="Macedonia";var ML="Mali";var MM="Myanmar";var MN="Mongolia";var MP="Northern Mariana Islands";var MR="Mauritania";var MS="Montserrat";var MT="Malta";var MU="Mauritius";var MW="Malawi";var MX="Mexico";var MY="Malaysia";var MZ="Mozambique";var NA="Namibia";var NC="New Caledonia";var NE="Niger";var NG="Nigeria";var NI="Nicaragua";var NL="Netherlands";var NO="Norway";var NP="Nepal";var NU="Niue";var NZ="New Zealand";var OM="Oman";var PA="Panama";var PE="Peru";var PF="French Polynesia";var PG="Papua New Guinea";var PH="Philippines";var PK="Pakistan";var PL="Poland";var PR="Puerto Rico";var PT="Portugal";var PY="Paraguay";var QA="Qatar";var RO="Romania";var RS="Serbia";var RU="Russia";var RW="Rwanda";var SA="Saudi Arabia";var SB="Solomon Islands";var SC="Seychelles";var SD="Sudan";var SE="Sweden";var SG="Singapore";var SH="Saint Helena";var SI="Slovenia";var SK="Slovakia";var SL="Sierra Leone";var SN="Senegal";var SO="Somalia";var SR="Suriname";var ST="Sao Tome and Principe";var SV="El Salvador";var SY="Syria";var SZ="Swaziland";var TC="Turks and Caicos Islands";var TD="Chad";var TG="Togo";var TH="Thailand";var TJ="Tajikistan";var TM="Turkmenistan";var TN="Tunisia";var TR="Turkey";var TV="Tuvalu";var TW="Taiwan";var TZ="Tanzania";var UA="Ukraine";var UG="Uganda";var US="United States";var UY="Uruguay";var UZ="Uzbekistan";var VC="Saint Vincent and the Grenadines";var VE="Venezuela";var VG="British Virgin Islands";var VN="Vietnam";var WS="Samoa";var YE="Yemen";var YT="Mayotte";var ZA="South Africa";var ZM="Zambia";var ZW="Zimbabwe";var countryNames = {AD:AD,AE:AE,AF:AF,AI:AI,AL:AL,AM:AM,AO:AO,AR:AR,AS:AS,AT:AT,AU:AU,AW:AW,AZ:AZ,BA:BA,BB:BB,BD:BD,BE:BE,BF:BF,BG:BG,BH:BH,BI:BI,BJ:BJ,BM:BM,BN:BN,BO:BO,BR:BR,BS:BS,BT:BT,BW:BW,BY:BY,BZ:BZ,CA:CA,CD:CD,CF:CF,CG:CG,CH:CH,CI:CI,CK:CK,CL:CL,CM:CM,CN:CN,CO:CO,CR:CR,CU:CU,CV:CV,CW:CW,CY:CY,CZ:CZ,DE:DE,DK:DK,DM:DM,DO:DO,DZ:DZ,EC:EC,EE:EE,EG:EG,ER:ER,ES:ES,ET:ET,FI:FI,FJ:FJ,FK:FK,FO:FO,FR:FR,GA:GA,GB:GB,GE:GE,GH:GH,GI:GI,GL:GL,GM:GM,GN:GN,GQ:GQ,GR:GR,GT:GT,GW:GW,GY:GY,HK:HK,HN:HN,HR:HR,HT:HT,HU:HU,ID:ID,IE:IE,IL:IL,IM:IM,IN:IN,IQ:IQ,IR:IR,IS:IS,IT:IT,JM:JM,JO:JO,JP:JP,KE:KE,KG:KG,KH:KH,KM:KM,KN:KN,KP:KP,KR:KR,KW:KW,KY:KY,KZ:KZ,LA:LA,LB:LB,LC:LC,LI:LI,LR:LR,LS:LS,LT:LT,LU:LU,LV:LV,LY:LY,MA:MA,MD:MD,ME:ME,MG:MG,MK:MK,ML:ML,MM:MM,MN:MN,MP:MP,MR:MR,MS:MS,MT:MT,MU:MU,MW:MW,MX:MX,MY:MY,MZ:MZ,NA:NA,NC:NC,NE:NE,NG:NG,NI:NI,NL:NL,NO:NO,NP:NP,NU:NU,NZ:NZ,OM:OM,PA:PA,PE:PE,PF:PF,PG:PG,PH:PH,PK:PK,PL:PL,PR:PR,PT:PT,PY:PY,QA:QA,RO:RO,RS:RS,RU:RU,RW:RW,SA:SA,SB:SB,SC:SC,SD:SD,SE:SE,SG:SG,SH:SH,SI:SI,SK:SK,SL:SL,SN:SN,SO:SO,SR:SR,ST:ST,SV:SV,SY:SY,SZ:SZ,TC:TC,TD:TD,TG:TG,TH:TH,TJ:TJ,TM:TM,TN:TN,TR:TR,TV:TV,TW:TW,TZ:TZ,UA:UA,UG:UG,US:US,UY:UY,UZ:UZ,VC:VC,VE:VE,VG:VG,VN:VN,WS:WS,YE:YE,YT:YT,ZA:ZA,ZM:ZM,ZW:ZW};
+
 /**
+ * @param {Location} location
+ * @return {string}
+ */
+
+function locationToPlainObj(location) {
+  if (typeof location === 'object' && location !== null && typeof location.name === 'string') {
+    const o = {
+      title: location.getName(),
+      city: location.getShortName(),
+      tzid: location.getTzid(),
+      latitude: location.getLatitude(),
+      longitude: location.getLongitude(),
+      cc: location.getCountryCode(),
+      country: countryNames[location.getCountryCode()]
+    };
+    ['admin1', 'asciiname', 'geo', 'zip', 'state', 'stateName', 'geonameid'].forEach(k => {
+      if (location[k]) {
+        o[k] = location[k];
+      }
+    });
+    return o;
+  } else {
+    return {
+      geo: 'none'
+    };
+  }
+}
+/**
  * Helper function to transform a string to make it more usable in a URL or filename.
@@ -45,3 +75,3 @@ * Converts to lowercase and replaces non-word characters with hyphen ('-').
 /**
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {string}
@@ -232,3 +262,3 @@ */
  * @param {Event[]} events
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {string}
@@ -445,3 +475,3 @@ */
  * @param {Event} e
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {string}
@@ -522,8 +552,6 @@ */
 
-var AD="Andorra";var AE="United Arab Emirates";var AF="Afghanistan";var AI="Anguilla";var AL="Albania";var AM="Armenia";var AO="Angola";var AR="Argentina";var AS="American Samoa";var AT="Austria";var AU="Australia";var AW="Aruba";var AZ="Azerbaijan";var BA="Bosnia and Herzegovina";var BB="Barbados";var BD="Bangladesh";var BE="Belgium";var BF="Burkina Faso";var BG="Bulgaria";var BH="Bahrain";var BI="Burundi";var BJ="Benin";var BM="Bermuda";var BN="Brunei";var BO="Bolivia";var BR="Brazil";var BS="Bahamas";var BT="Bhutan";var BW="Botswana";var BY="Belarus";var BZ="Belize";var CA="Canada";var CD="Democratic Republic of the Congo";var CF="Central African Republic";var CG="Republic of the Congo";var CH="Switzerland";var CI="Ivory Coast";var CK="Cook Islands";var CL="Chile";var CM="Cameroon";var CN="China";var CO="Colombia";var CR="Costa Rica";var CU="Cuba";var CV="Cape Verde";var CW="Curacao";var CY="Cyprus";var CZ="Czech Republic";var DE="Germany";var DK="Denmark";var DM="Dominica";var DO="Dominican Republic";var DZ="Algeria";var EC="Ecuador";var EE="Estonia";var EG="Egypt";var ER="Eritrea";var ES="Spain";var ET="Ethiopia";var FI="Finland";var FJ="Fiji";var FK="Falkland Islands";var FO="Faroe Islands";var FR="France";var GA="Gabon";var GB="United Kingdom";var GE="Georgia";var GH="Ghana";var GI="Gibraltar";var GL="Greenland";var GM="Gambia";var GN="Guinea";var GQ="Equatorial Guinea";var GR="Greece";var GT="Guatemala";var GW="Guinea-Bissau";var GY="Guyana";var HK="Hong Kong";var HN="Honduras";var HR="Croatia";var HT="Haiti";var HU="Hungary";var ID="Indonesia";var IE="Ireland";var IL="Israel";var IM="Isle of Man";var IN="India";var IQ="Iraq";var IR="Iran";var IS="Iceland";var IT="Italy";var JM="Jamaica";var JO="Jordan";var JP="Japan";var KE="Kenya";var KG="Kyrgyzstan";var KH="Cambodia";var KM="Comoros";var KN="Saint Kitts and Nevis";var KP="North Korea";var KR="South Korea";var KW="Kuwait";var KY="Cayman Islands";var KZ="Kazakhstan";var LA="Laos";var LB="Lebanon";var LC="Saint Lucia";var LI="Liechtenstein";var LR="Liberia";var LS="Lesotho";var LT="Lithuania";var LU="Luxembourg";var LV="Latvia";var LY="Libya";var MA="Morocco";var MD="Moldova";var ME="Montenegro";var MG="Madagascar";var MK="Macedonia";var ML="Mali";var MM="Myanmar";var MN="Mongolia";var MP="Northern Mariana Islands";var MR="Mauritania";var MS="Montserrat";var MT="Malta";var MU="Mauritius";var MW="Malawi";var MX="Mexico";var MY="Malaysia";var MZ="Mozambique";var NA="Namibia";var NC="New Caledonia";var NE="Niger";var NG="Nigeria";var NI="Nicaragua";var NL="Netherlands";var NO="Norway";var NP="Nepal";var NU="Niue";var NZ="New Zealand";var OM="Oman";var PA="Panama";var PE="Peru";var PF="French Polynesia";var PG="Papua New Guinea";var PH="Philippines";var PK="Pakistan";var PL="Poland";var PR="Puerto Rico";var PT="Portugal";var PY="Paraguay";var QA="Qatar";var RO="Romania";var RS="Serbia";var RU="Russia";var RW="Rwanda";var SA="Saudi Arabia";var SB="Solomon Islands";var SC="Seychelles";var SD="Sudan";var SE="Sweden";var SG="Singapore";var SH="Saint Helena";var SI="Slovenia";var SK="Slovakia";var SL="Sierra Leone";var SN="Senegal";var SO="Somalia";var SR="Suriname";var ST="Sao Tome and Principe";var SV="El Salvador";var SY="Syria";var SZ="Swaziland";var TC="Turks and Caicos Islands";var TD="Chad";var TG="Togo";var TH="Thailand";var TJ="Tajikistan";var TM="Turkmenistan";var TN="Tunisia";var TR="Turkey";var TV="Tuvalu";var TW="Taiwan";var TZ="Tanzania";var UA="Ukraine";var UG="Uganda";var US="United States";var UY="Uruguay";var UZ="Uzbekistan";var VC="Saint Vincent and the Grenadines";var VE="Venezuela";var VG="British Virgin Islands";var VN="Vietnam";var WS="Samoa";var YE="Yemen";var YT="Mayotte";var ZA="South Africa";var ZM="Zambia";var ZW="Zimbabwe";var countryNames = {AD:AD,AE:AE,AF:AF,AI:AI,AL:AL,AM:AM,AO:AO,AR:AR,AS:AS,AT:AT,AU:AU,AW:AW,AZ:AZ,BA:BA,BB:BB,BD:BD,BE:BE,BF:BF,BG:BG,BH:BH,BI:BI,BJ:BJ,BM:BM,BN:BN,BO:BO,BR:BR,BS:BS,BT:BT,BW:BW,BY:BY,BZ:BZ,CA:CA,CD:CD,CF:CF,CG:CG,CH:CH,CI:CI,CK:CK,CL:CL,CM:CM,CN:CN,CO:CO,CR:CR,CU:CU,CV:CV,CW:CW,CY:CY,CZ:CZ,DE:DE,DK:DK,DM:DM,DO:DO,DZ:DZ,EC:EC,EE:EE,EG:EG,ER:ER,ES:ES,ET:ET,FI:FI,FJ:FJ,FK:FK,FO:FO,FR:FR,GA:GA,GB:GB,GE:GE,GH:GH,GI:GI,GL:GL,GM:GM,GN:GN,GQ:GQ,GR:GR,GT:GT,GW:GW,GY:GY,HK:HK,HN:HN,HR:HR,HT:HT,HU:HU,ID:ID,IE:IE,IL:IL,IM:IM,IN:IN,IQ:IQ,IR:IR,IS:IS,IT:IT,JM:JM,JO:JO,JP:JP,KE:KE,KG:KG,KH:KH,KM:KM,KN:KN,KP:KP,KR:KR,KW:KW,KY:KY,KZ:KZ,LA:LA,LB:LB,LC:LC,LI:LI,LR:LR,LS:LS,LT:LT,LU:LU,LV:LV,LY:LY,MA:MA,MD:MD,ME:ME,MG:MG,MK:MK,ML:ML,MM:MM,MN:MN,MP:MP,MR:MR,MS:MS,MT:MT,MU:MU,MW:MW,MX:MX,MY:MY,MZ:MZ,NA:NA,NC:NC,NE:NE,NG:NG,NI:NI,NL:NL,NO:NO,NP:NP,NU:NU,NZ:NZ,OM:OM,PA:PA,PE:PE,PF:PF,PG:PG,PH:PH,PK:PK,PL:PL,PR:PR,PT:PT,PY:PY,QA:QA,RO:RO,RS:RS,RU:RU,RW:RW,SA:SA,SB:SB,SC:SC,SD:SD,SE:SE,SG:SG,SH:SH,SI:SI,SK:SK,SL:SL,SN:SN,SO:SO,SR:SR,ST:ST,SV:SV,SY:SY,SZ:SZ,TC:TC,TD:TD,TG:TG,TH:TH,TJ:TJ,TM:TM,TN:TN,TR:TR,TV:TV,TW:TW,TZ:TZ,UA:UA,UG:UG,US:US,UY:UY,UZ:UZ,VC:VC,VE:VE,VG:VG,VN:VN,WS:WS,YE:YE,YT:YT,ZA:ZA,ZM:ZM,ZW:ZW};
-
 /**
  * Formats a list events for the classic Hebcal.com JSON API response
  * @param {Event[]} events
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @param {boolean} [leyning=true]
@@ -538,25 +566,3 @@ * @return {Object}
   };
-  const location = options.location;
-
-  if (typeof location === 'object' && typeof location.name === 'string') {
-    result.location = {
-      title: location.getName(),
-      city: location.getShortName(),
-      tzid: location.getTzid(),
-      latitude: location.getLatitude(),
-      longitude: location.getLongitude(),
-      cc: location.getCountryCode(),
-      country: countryNames[location.getCountryCode()]
-    };
-    ['admin1', 'asciiname', 'geo', 'zip', 'state', 'stateName', 'geonameid'].forEach(k => {
-      if (location[k]) {
-        result.location[k] = location[k];
-      }
-    });
-  } else {
-    result.location = {
-      geo: 'none'
-    };
-  }
-
+  result.location = locationToPlainObj(options.location);
   result.items = events.map(ev => eventToClassicApiObject(ev, options, leyning));
@@ -568,3 +574,3 @@ return result;
  * @param {Event} ev
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @param {boolean} [leyning=true]
@@ -783,3 +789,3 @@ * @return {Object}
  * @param {Event[]} events
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {string}
@@ -848,3 +854,3 @@ */
  * @param {Event} ev
- * @param {HebrewCalendar.Options} options
+ * @param {CalOptions} options
  * @return {string}
@@ -864,3 +870,3 @@ */
  * @param {string} mainUrl
- * @param {HebrewCalendar.Options} [options]
+ * @param {CalOptions} [options]
  * @return {string}
@@ -984,2 +990,3 @@ */
 exports.holidayDescription = holidayDescription;
+exports.locationToPlainObj = locationToPlainObj;
 exports.makeAnchor = makeAnchor;
@@ -986,0 +993,0 @@ exports.makeTorahMemoText = makeTorahMemoText;

package.json

 {
   "name": "@hebcal/rest-api",
-  "version": "3.13.2",
+  "version": "3.14.0",
   "author": "Michael J. Radwin (https://github.com/mjradwin)",
@@ -24,4 +24,4 @@ "keywords": [
   "dependencies": {
-    "@hebcal/core": "^3.36.2",
-    "@hebcal/leyning": "^4.13.2"
+    "@hebcal/core": "^3.36.3",
+    "@hebcal/leyning": "^4.13.3"
   },
@@ -47,4 +47,4 @@ "scripts": {
   "devDependencies": {
-    "@babel/core": "^7.17.9",
-    "@babel/preset-env": "^7.16.11",
+    "@babel/core": "^7.17.10",
+    "@babel/preset-env": "^7.17.10",
     "@babel/register": "^7.17.7",
@@ -54,5 +54,5 @@ "@rollup/plugin-babel": "^5.3.1",
     "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^13.2.1",
+    "@rollup/plugin-node-resolve": "^13.3.0",
     "ava": "^4.2.0",
-    "core-js": "^3.22.2",
+    "core-js": "^3.22.4",
     "eslint": "^8.14.0",
@@ -62,5 +62,5 @@ "eslint-config-google": "^0.14.0",
     "jsdoc-to-markdown": "^7.1.1",
-    "rollup": "^2.70.2",
+    "rollup": "^2.71.1",
     "rollup-plugin-terser": "^7.0.2"
   }
 }

README.md

@@ -35,2 +35,4 @@ # @hebcal/rest-api
 <dl>
+<dt><a href="#locationToPlainObj">locationToPlainObj(location)</a> ⇒ <code>string</code></dt>
+<dd></dd>
 <dt><a href="#makeAnchor">makeAnchor(s)</a> ⇒ <code>string</code></dt>
@@ -92,4 +94,6 @@ <dd><p>Helper function to transform a string to make it more usable in a URL or filename.
 <dd></dd>
-<dt><a href="#eventToRssItem">eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl)</a> ⇒ <code>string</code></dt>
+<dt><a href="#eventToRssItem2">eventToRssItem2(ev, options)</a> ⇒ <code>string</code></dt>
 <dd></dd>
+<dt><a href="#eventToRssItem">eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl, [options])</a> ⇒ <code>string</code></dt>
+<dd></dd>
 <dt><a href="#eventToFullCalendar">eventToFullCalendar(ev, tzid, il)</a> ⇒ <code>Object</code></dt>
@@ -100,2 +104,11 @@ <dd><p>Converts a Hebcal event to a FullCalendar.io object</p>
 
+<a name="locationToPlainObj"></a>
+
+## locationToPlainObj(location) ⇒ <code>string</code>
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| location | <code>Location</code> | 
+
 <a name="makeAnchor"></a>
@@ -124,3 +137,3 @@
 | --- | --- |
-| options | <code>HebrewCalendar.Options</code> | 
+| options | <code>CalOptions</code> | 
 
@@ -217,3 +230,3 @@ <a name="pad2"></a>
 | events | <code>Array.&lt;Event&gt;</code> | 
-| options | <code>HebrewCalendar.Options</code> | 
+| options | <code>CalOptions</code> | 
 
@@ -269,3 +282,3 @@ <a name="getHolidayDescription"></a>
 | e | <code>Event</code> | 
-| options | <code>HebrewCalendar.Options</code> | 
+| options | <code>CalOptions</code> | 
 
@@ -292,3 +305,3 @@ <a name="eventsToCsv"></a>
 | events | <code>Array.&lt;Event&gt;</code> |  | 
-| options | <code>HebrewCalendar.Options</code> |  | 
+| options | <code>CalOptions</code> |  | 
 | [leyning] | <code>boolean</code> | <code>true</code> | 
@@ -306,3 +319,3 @@
 | ev | <code>Event</code> |  | 
-| options | <code>HebrewCalendar.Options</code> |  | 
+| options | <code>CalOptions</code> |  | 
 | [leyning] | <code>boolean</code> | <code>true</code> | 
@@ -351,7 +364,17 @@
 | events | <code>Array.&lt;Event&gt;</code> | 
-| options | <code>HebrewCalendar.Options</code> | 
+| options | <code>CalOptions</code> | 
 
+<a name="eventToRssItem2"></a>
+
+## eventToRssItem2(ev, options) ⇒ <code>string</code>
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| ev | <code>Event</code> | 
+| options | <code>CalOptions</code> | 
+
 <a name="eventToRssItem"></a>
 
-## eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl) ⇒ <code>string</code>
+## eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl, [options]) ⇒ <code>string</code>
 **Kind**: global function  
@@ -367,2 +390,3 @@
 | mainUrl | <code>string</code> | 
+| [options] | <code>CalOptions</code> | 
 
@@ -369,0 +393,0 @@ <a name="eventToFullCalendar"></a>

rest-api.d.ts

 /// <reference types="node"/>
 
-import {HebrewCalendar, Event, Location} from '@hebcal/core';
+import {Event, Location, CalOptions} from '@hebcal/core';
 
@@ -9,12 +9,12 @@ declare module '@hebcal/rest-api' {
    */
-  export function eventToCsv(e: Event, options: HebrewCalendar.Options): string;
-  export function eventsToCsv(events: Event[], options: HebrewCalendar.Options): string;
+  export function eventToCsv(e: Event, options: CalOptions): string;
+  export function eventsToCsv(events: Event[], options: CalOptions): string;
   /**
    * Formats a list events for the classic Hebcal.com JSON API response
    */
-  export function eventsToClassicApi(events: Event[], options: HebrewCalendar.Options, leyning?: boolean): any;
+  export function eventsToClassicApi(events: Event[], options: CalOptions, leyning?: boolean): any;
   /**
    * Converts a Hebcal event to a classic Hebcal.com JSON API object
    */
-  export function eventToClassicApiObject(ev: Event, options: HebrewCalendar.Options, leyning?: boolean): any;
+  export function eventToClassicApiObject(ev: Event, options: CalOptions, leyning?: boolean): any;
   /**
@@ -43,6 +43,6 @@ * Converts a Hebcal event to a FullCalendar.io object
   export function eventsToRss(events: Event[], location: Location, mainUrl: string, selfUrl: string, lang?: string, evPubDate?: boolean): string;
-  export function eventsToRss2(events: Event[], options: HebrewCalendar.Options): string;
-  export function eventToRssItem(ev: Event, evPubDate: boolean, lastBuildDate: string, dayFormat: Intl.DateTimeFormat, location: Location, baseUrl: string, options?: HebrewCalendar.Options): string;
-  export function eventToRssItem2(ev: Event, options: HebrewCalendar.Options): string;
-  export function getDownloadFilename(options: HebrewCalendar.Options): string;
+  export function eventsToRss2(events: Event[], options: CalOptions): string;
+  export function eventToRssItem(ev: Event, evPubDate: boolean, lastBuildDate: string, dayFormat: Intl.DateTimeFormat, location: Location, baseUrl: string, options?: CalOptions): string;
+  export function eventToRssItem2(ev: Event, options: CalOptions): string;
+  export function getDownloadFilename(options: CalOptions): string;
   export function pad2(number: number): string;
@@ -78,3 +78,3 @@ export function pad4(number: number): string;
    */
-  export function getCalendarTitle(events: Event[], options: HebrewCalendar.Options): string;
+  export function getCalendarTitle(events: Event[], options: CalOptions): string;
 
@@ -87,2 +87,4 @@ /**
 
+  export function locationToPlainObj(location: Location): string;
+
   export interface StringMap {
@@ -89,0 +91,0 @@ [key: string]: string;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

337413

increased by0.86%

Lines of code

6391

increased by0.71%

Number of lines in readme file

395

increased by6.47%

Dependency changes

• Updated@hebcal/core@^3.36.3

• Updated@hebcal/leyning@^4.13.3