1.1.0 • Published 8 years ago
libcal-events v1.1.0
LibCal feed(s)
Retreive LibCal events as JSON objects. I wrote a Blog Post™ about how this works (tldr: it's pulling the same data as LibCal's calendar widgets).
Note: this is currently only pulling Calendar events, as a JSON feed of library/branch hours already exists. Not too sure how this works with room bookings either.
usage
var libcalEvents = require('libcal-events')
var iid = 123
var calendars = [1111, 1212]
libcalEvents(iid, calendars, function (err, events) {
console.log(events.sort(function (a,b) {
return a.start > b.start
}))
})libcalEvents(iid, calendars, callback)
callback(err, events) will be passed an array of events objects. Note that this
won't be sorted, but will be arranged in an order similar to the calendars array.
libcalEvents(opts, callback)
with opts being an object with the following options:
| key | value |
|---|---|
iid | the institution's LibApps ID |
calendars | the id(s) of the calendar requested (use an array for multiples) |
start | start date for events (either Date object or YYYY-MM-DD string) |
end | end date for events (either Date object or YYYY-MM-DD string) |
base_url | if using a proxy for LibCal, the url to use |
Okay, but what do these events objects look like?
{
"id": "2202354",
"title": "Tutoring - Wescoe",
"start": "2015-12-09T10:15:00",
"end": "2015-12-09T11:30:00",
"url": "http://muhlenberg.libcal.com/event/2202354",
"allDay": false,
"backgroundColor": "#B3C8EF",
"borderColor": "#8fa0bf",
"textColor": "#222",
"short_desc": "",
"location": "Seminar C",
"campus": "",
"seats": "",
"pres": "",
"className": [
"cat23118"
],
"categories": "Meeting"
}license
MIT