@hebcal/rest-api 3.19.5 → 4.2.0

package/README.md

@@ -44,15 +44,9 @@ Converts to lowercase and replaces non-word characters with hyphen ('-')
 <dd></dd>
 <dt><a href="#pad4">pad4(number)</a> ⇒ <code>string</code></dt>
 <dd></dd>
-<dt><del><a href="#timeZoneOffsetStr">timeZoneOffsetStr(tzid, date)</a> ⇒ <code>string</code></del></dt>
-<dd><p>Get offset string (like &quot;+05:00&quot; or &quot;-08:00&quot;) from tzid (like &quot;Europe/Moscow&quot;)</p>
-</dd>
 <dt><a href="#toISOString">toISOString(d)</a> ⇒ <code>string</code></dt>
 <dd><p>Returns just the date portion as YYYY-MM-DD</p>
 </dd>
-<dt><del><a href="#toISOStringWithTimezone">toISOStringWithTimezone(date, timeStr, tzid)</a> ⇒ <code>string</code></del></dt>
-<dd><p>Returns a string like &quot;2018-09-01T12:30:00-05:00&quot;</p>
-</dd>
 <dt><a href="#getEventCategories">getEventCategories(ev)</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
 <dd><p>Returns a category and subcategory name</p>
 </dd>
@@ -86,14 +80,10 @@ Converts to lowercase and replaces non-word characters with hyphen (&#39;-&#39;)
 <dd></dd>
 <dt><a href="#formatLeyningResult">formatLeyningResult(reading)</a> ⇒ <code>Object</code></dt>
 <dd></dd>
-<dt><a href="#eventsToRss">eventsToRss(events, location, mainUrl, selfUrl, [lang], [evPubDate])</a> ⇒ <code>string</code></dt>
-<dd></dd>
 <dt><a href="#eventsToRss2">eventsToRss2(events, options)</a> ⇒ <code>string</code></dt>
 <dd></dd>
 <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>
 <dd><p>Converts a Hebcal event to a FullCalendar.io object</p>
 </dd>
@@ -151,20 +141,6 @@ makeAnchor('Rosh Chodesh Adar II') // 'rosh-chodesh-adar-ii'
 | --- | --- |
 | number | <code>number</code> | 
 
-<a name="timeZoneOffsetStr"></a>
-
-## ~~timeZoneOffsetStr(tzid, date) ⇒ <code>string</code>~~
-***Deprecated***
-
-Get offset string (like "+05:00" or "-08:00") from tzid (like "Europe/Moscow")
-
-**Kind**: global function  
-
-| Param | Type |
-| --- | --- |
-| tzid | <code>string</code> | 
-| date | <code>Date</code> | 
-
 <a name="toISOString"></a>
 
 ## toISOString(d) ⇒ <code>string</code>
@@ -176,21 +152,6 @@ Returns just the date portion as YYYY-MM-DD
 | --- | --- |
 | d | <code>Date</code> | 
 
-<a name="toISOStringWithTimezone"></a>
-
-## ~~toISOStringWithTimezone(date, timeStr, tzid) ⇒ <code>string</code>~~
-***Deprecated***
-
-Returns a string like "2018-09-01T12:30:00-05:00"
-
-**Kind**: global function  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| date | <code>Date</code> |  |
-| timeStr | <code>string</code> | must be formatted with only hours and minutes, like "17:12" |
-| tzid | <code>string</code> | like "America/New_York" |
-
 <a name="getEventCategories"></a>
 
 ## getEventCategories(ev) ⇒ <code>Array.&lt;string&gt;</code>
@@ -329,21 +290,7 @@ Converts a Hebcal event to a classic Hebcal.com JSON API object
 
 | Param | Type |
 | --- | --- |
-| reading | <code>leyn.Leyning</code> | 
-
-<a name="eventsToRss"></a>
-
-## eventsToRss(events, location, mainUrl, selfUrl, [lang], [evPubDate]) ⇒ <code>string</code>
-**Kind**: global function  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| events | <code>Array.&lt;Event&gt;</code> |  |  |
-| location | <code>Location</code> |  |  |
-| mainUrl | <code>string</code> |  |  |
-| selfUrl | <code>string</code> |  |  |
-| [lang] | <code>string</code> | <code>&quot;en-US&quot;</code> | language such as 'he' (default 'en-US') |
-| [evPubDate] | <code>boolean</code> | <code>true</code> | if true, use event time as pubDate (false uses lastBuildDate) |
+| reading | <code>Leyning</code> | 
 
 <a name="eventsToRss2"></a>
 
@@ -365,21 +312,6 @@ Converts a Hebcal event to a classic Hebcal.com JSON API object
 | ev | <code>Event</code> | 
 | options | <code>CalOptions</code> | 
 
-<a name="eventToRssItem"></a>
-
-## eventToRssItem(ev, evPubDate, lastBuildDate, dayFormat, location, mainUrl, [options]) ⇒ <code>string</code>
-**Kind**: global function  
-
-| Param | Type |
-| --- | --- |
-| ev | <code>Event</code> | 
-| evPubDate | <code>boolean</code> | 
-| lastBuildDate | <code>string</code> | 
-| dayFormat | <code>Intl.DateTimeFormat</code> | 
-| location | <code>Location</code> | 
-| mainUrl | <code>string</code> | 
-| [options] | <code>CalOptions</code> | 
-
 <a name="eventToFullCalendar"></a>
 
 ## eventToFullCalendar(ev, tzid, il) ⇒ <code>Object</code>