mirror of
https://github.com/MichMich/MagicMirror.git
synced 2025-09-15 00:22:49 +00:00
51
modules/default/calendar/vendor/ical.js/readme.md
vendored
Normal file
51
modules/default/calendar/vendor/ical.js/readme.md
vendored
Normal file
@@ -0,0 +1,51 @@
|
||||
# ical.js #
|
||||
(Formerly node-ical)
|
||||
|
||||
[](https://travis-ci.org/peterbraden/ical.js)
|
||||
|
||||
A tolerant, minimal icalendar parser for javascript/node
|
||||
(http://tools.ietf.org/html/rfc5545)
|
||||
|
||||
|
||||
## Install - Node.js ##
|
||||
|
||||
ical.js is availble on npm:
|
||||
|
||||
npm install ical
|
||||
|
||||
|
||||
|
||||
## API ##
|
||||
|
||||
ical.parseICS(str)
|
||||
|
||||
Parses a string with an ICS File
|
||||
|
||||
var data = ical.parseFile(filename)
|
||||
|
||||
Reads in the specified iCal file, parses it and returns the parsed data
|
||||
|
||||
ical.fromURL(url, options, function(err, data) {} )
|
||||
|
||||
Use the request library to fetch the specified URL (```opts``` gets passed on to the ```request()``` call), and call the function with the result (either an error or the data).
|
||||
|
||||
|
||||
|
||||
## Example 1 - Print list of upcoming node conferences (see example.js)
|
||||
```javascript
|
||||
var ical = require('ical')
|
||||
, months = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
|
||||
|
||||
ical.fromURL('http://lanyrd.com/topics/nodejs/nodejs.ics', {}, function(err, data) {
|
||||
for (var k in data){
|
||||
if (data.hasOwnProperty(k)) {
|
||||
var ev = data[k]
|
||||
console.log("Conference",
|
||||
ev.summary,
|
||||
'is in',
|
||||
ev.location,
|
||||
'on the', ev.start.getDate(), 'of', months[ev.start.getMonth()]);
|
||||
}
|
||||
}
|
||||
});
|
||||
```
|
Reference in New Issue
Block a user