@hebcal/rest-api 4.5.1 → 4.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -3
- package/dist/bundle.js +230 -191
- package/dist/bundle.min.js +2 -2
- package/dist/fullcalendar.js +2 -2
- package/dist/fullcalendar.min.js +2 -2
- package/dist/index.js +27 -6
- package/dist/index.mjs +27 -6
- package/package.json +15 -15
- package/rest-api.d.ts +18 -1
package/README.md
CHANGED
|
@@ -32,8 +32,9 @@ console.log(JSON.stringify(csv));
|
|
|
32
32
|
## Functions
|
|
33
33
|
|
|
34
34
|
<dl>
|
|
35
|
-
<dt><a href="#locationToPlainObj">locationToPlainObj(location)</a> ⇒ <code>
|
|
36
|
-
<dd
|
|
35
|
+
<dt><a href="#locationToPlainObj">locationToPlainObj(location)</a> ⇒ <code><a href="#LocationPlainObj">LocationPlainObj</a></code></dt>
|
|
36
|
+
<dd><p>Converts a @hebcal/core <code>Location</code> to a plain JS object.</p>
|
|
37
|
+
</dd>
|
|
37
38
|
<dt><a href="#makeAnchor">makeAnchor(s)</a> ⇒ <code>string</code></dt>
|
|
38
39
|
<dd><p>Helper function to transform a string to make it more usable in a URL or filename.
|
|
39
40
|
Converts to lowercase and replaces non-word characters with hyphen ('-').</p>
|
|
@@ -89,9 +90,19 @@ Converts to lowercase and replaces non-word characters with hyphen ('-')
|
|
|
89
90
|
</dd>
|
|
90
91
|
</dl>
|
|
91
92
|
|
|
93
|
+
## Typedefs
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt><a href="#LocationPlainObj">LocationPlainObj</a> : <code>Object</code></dt>
|
|
97
|
+
<dd><p>Location information</p>
|
|
98
|
+
</dd>
|
|
99
|
+
</dl>
|
|
100
|
+
|
|
92
101
|
<a name="locationToPlainObj"></a>
|
|
93
102
|
|
|
94
|
-
## locationToPlainObj(location) ⇒ <code>
|
|
103
|
+
## locationToPlainObj(location) ⇒ [<code>LocationPlainObj</code>](#LocationPlainObj)
|
|
104
|
+
Converts a @hebcal/core `Location` to a plain JS object.
|
|
105
|
+
|
|
95
106
|
**Kind**: global function
|
|
96
107
|
|
|
97
108
|
| Param | Type |
|
|
@@ -324,3 +335,29 @@ Converts a Hebcal event to a FullCalendar.io object
|
|
|
324
335
|
| ev | <code>Event</code> | |
|
|
325
336
|
| tzid | <code>string</code> | timeZone identifier |
|
|
326
337
|
| il | <code>boolean</code> | true if Israel |
|
|
338
|
+
|
|
339
|
+
<a name="LocationPlainObj"></a>
|
|
340
|
+
|
|
341
|
+
## LocationPlainObj : <code>Object</code>
|
|
342
|
+
Location information
|
|
343
|
+
|
|
344
|
+
**Kind**: global typedef
|
|
345
|
+
**Properties**
|
|
346
|
+
|
|
347
|
+
| Name | Type |
|
|
348
|
+
| --- | --- |
|
|
349
|
+
| title | <code>string</code> |
|
|
350
|
+
| city | <code>string</code> |
|
|
351
|
+
| tzid | <code>string</code> |
|
|
352
|
+
| latitude | <code>number</code> |
|
|
353
|
+
| longitude | <code>number</code> |
|
|
354
|
+
| cc | <code>string</code> |
|
|
355
|
+
| country | <code>string</code> |
|
|
356
|
+
| admin1 | <code>string</code> |
|
|
357
|
+
| asciiname | <code>string</code> |
|
|
358
|
+
| geo | <code>string</code> |
|
|
359
|
+
| zip | <code>string</code> |
|
|
360
|
+
| state | <code>string</code> |
|
|
361
|
+
| stateName | <code>string</code> |
|
|
362
|
+
| geonameid | <code>number</code> |
|
|
363
|
+
|