ical-generator
ical-generator is a small piece of code which generates ical calendar files. I use this to generate subscriptionable calendar feeds.
Installation
npm install ical-generator
Example
var ical = require('ical-generator'),
http = require('http'),
cal = ical();
cal.setDomain('sebbo.net').setName('my first iCal');
cal.addEvent({
start: new Date(),
end: new Date(new Date().getTime() + 3600000),
summary: 'Example Event',
description: 'It works ;)',
location: 'my room',
url: 'http://sebbo.net/'
});
http.createServer(function(req, res) {
cal.serve(res);
}).listen(3000, '127.0.0.1');
console.log('Server running at http://127.0.0.1:3000/');
API
setDomain(domain)
Use this method to set your server's hostname. It will be used to generate the feed's UID. Default hostname is localhost.
setName(name)
Use this method to set your feed's name.
setProdID(prodID)
This method is used to overwrite the default ProdID:
cal.setProdID({
company: 'My Company',
product: 'My Product',
language: 'EN'
});
addEvent(options)
Add an event. Options is an plain object, that configure the event.
options.uid (String)
Event UID. If not set, an UID will be generated randomly.
options.start (Date Object, required)
Appointment date of beginning
options.end (Date Object, required)
Appointment date of end
options.stamp (Date Object)
Appointment date of creation
options.summary (String, required)
Appointment summary
options.description (String)
Appointment description
options.location (String)
Appointment location
options.organizer (Plain Object)
Appointment organizer
cal.addEvent({
start: new Date(),
end: new Date(new Date().getTime() + 3600000),
summary: 'Example Event',
description: 'Appointment with Organizer',
location: 'Room 123',
organizer: {
name: 'Organizer\'s Name',
email: 'organizer@example.com'
}
});
options.url (String)
Appointment Website
save(file[, cb])
Save Calendar to disk asynchronously using fs.writeFile
saveSync(file)
Save Calendar to disk synchronously using fs.writeFileSync
serve(response)
Send Calendar to the User when using HTTP. See example above.
toString()
Return Calendar as a String.
clear()
Empty the Calender.