ical-generator is a small piece of code which generates ical calendar files. I use this to generate subscriptionable calendar feeds.
npm install ical-generator
const ical = require('ical-generator');
const http = require('http');
const cal = ical({domain: 'github.com', name: 'my first iCal'});
// overwrite domain
cal.domain('sebbo.net');
cal.createEvent({
start: moment(),
end: moment().add(1, 'hour'),
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', function() {
console.log('Server running at http://127.0.0.1:3000/');
});const ical = require('ical-generator');
// Create new Calendar and set optional fields
const cal = ical({
domain: 'sebbo.net',
prodId: {company: 'superman-industries.com', product: 'ical-generator'},
name: 'My Testfeed',
timezone: 'Europe/Berlin'
});
// You can also set values like this…
cal.domain('sebbo.net');
// … or get values
cal.domain(); // --> "sebbo.net"
// create a new event
const event = cal.createEvent({
start: moment(),
end: moment().add(1, 'hour'),
timestamp: moment(),
summary: 'My Event',
organizer: 'Sebastian Pekarek <[email protected]>'
});
// like above, you can also set/change values like this…
event.summary('My Super Mega Awesome Event');
// get the iCal string
cal.toString(); // --> "BEGIN:VCALENDAR…"
// You can also create events directly with ical()
ical({
domain: 'sebbo.net',
prodId: '//superman-industries.com//ical-generator//EN',
events: [
{
start: moment(),
end: moment().add(1, 'hour'),
timestamp: moment(),
summary: 'My Event',
organizer: 'Sebastian Pekarek <[email protected]>'
}
]
}).toString();Creates a new Calendar (ICalCalendar).
const ical = require('ical-generator');
const cal = ical();You can pass options to setup your calendar or use setters to do this.
const ical = require('ical-generator');
const cal = ical({domain: 'sebbo.net'});
// is the same as
const cal = ical().domain('sebbo.net');
// is the same as
const cal = ical();
cal.domain('sebbo.net');Use this method to set your server's hostname. It will be used to generate the feed's UID. Default hostname is your
server's one (require('os').hostname()).
Use this method to overwrite the default Product Identifier (//sebbo.net//ical-generator//EN). prodId can be either
a valid Product Identifier or an object:
cal.prodId({
company: 'My Company',
product: 'My Product',
language: 'EN' // optional, defaults to EN
});
// OR
cal.prodId('//My Company//My Product//EN');Use this method to set your feed's name. Is used to fill NAME and X-WR-CALNAME in your iCal file.
Use this method to set your feed's URL.
const cal = ical().url('https://example.com/calendar.ical');Use this method to set your feed's CALSCALE. There is no default value for this property and it will not appear in your
iCal file unless set. The iCal standard specifies this as GREGORIAN if no value is present.
const cal = ical().scale('gregorian');Use this method to set your feed's timezone. Is used to fill TIMEZONE-ID and X-WR-TIMEZONE in your iCal.
const cal = ical().timezone('Europe/Berlin');Calendar method. May be any of the following: publish, request, reply, add, cancel, refresh, counter, declinecounter.
Use this method to set your feed's time to live (in seconds). Is used to fill REFRESH-INTERVAL and X-PUBLISHED-TTL in your iCal.
const cal = ical().ttl(60 * 60 * 24);Creates a new Event (ICalEvent) and returns it. Use options to prefill the event's attributes.
Calling this method without options will create an empty event.
const ical = require('ical-generator');
const cal = ical();
const event = cal.createEvent({summary: 'My Event'});
// overwrite event summary
event.summary('Your Event');Add Events to calendar or return all attached events.
const cal = ical();
cal.events([
{
start: new Date(),
end: new Date(new Date().getTime() + 3600000),
summary: 'Example Event',
description: 'It works ;)',
url: 'http://sebbo.net/'
}
]);
cal.events(); // --> [ICalEvent]Save Calendar to disk asynchronously using fs.writeFile. Won't work in browsers.
Save Calendar to disk synchronously using fs.writeFileSync. Won't work in browsers.
Send Calendar to the User when using HTTP. See Quick Start above. Won't work in browsers. Defaults to 'calendar.ics'.
Returns a download URL using the Blob. Only supported in browsers supporting this API.
Return Calendar as a String.
Return a shallow copy of the calendar's options for JSON stringification. Can be used for persistence.
const cal = ical();
const json = JSON.stringify(cal);
// later
cal = ical(json);Returns the amount of events in the calendar.
Empty the Calender.
Use this method to set the event's ID. If not set, an UID will be generated randomly. When output, the ID will be suffixed with '@' + your calendar's domain.
Use this method to set the event's revision sequence number of the calendar component within a sequence of revisions.
Appointment date of beginning as Date object. This is required for all events!
Appointment date of end as Date object.
Use this method to set your event's timezone using the TZID property parameter on start and end dates, as per date-time form #3 in section 3.3.5 of RFC 554.
This and the 'floating' flag (see below) are mutually exclusive, and setting a timezone will unset the 'floating' flag. If neither 'timezone' nor 'floating' are set, the date will be output with in UTC format (see date-time form #2 in section 3.3.5 of RFC 554).
Appointment date of creation as Date object. Defaults to new Date().
When allDay == true -> appointment is for the whole day
Appointment is a "floating" time. From section 3.3.12 of RFC 554:
Time values of this type are said to be "floating" and are not bound to any time zone in particular. They are used to represent the same hour, minute, and second value regardless of which time zone is currently being observed. For example, an event can be defined that indicates that an individual will be busy from 11:00 AM to 1:00 PM every day, no matter which time zone the person is in. In these cases, a local time can be specified.
This and the 'timezone' setting (see above) are mutually exclusive, and setting the floating flag will unset the 'timezone'. If neither 'timezone' nor 'floating' are set, the date will be output with in UTC format (see date-time form #2 in section 3.3.5 of RFC 554).
Appointment is a repeating event
event.repeating({
freq: 'MONTHLY', // required
count: 5,
interval: 2,
until: new Date('Jan 01 2014 00:00:00 UTC'),
byDay: ['su', 'mo'], // repeat only sunday and monday
byMonth: [1, 2], // repeat only in january und february,
byMonthDay: [1, 15], // repeat only on the 1st and 15th
bySetPos: 3, // repeat every 3rd sunday (will take the first element of the byDay array)
exclude: [new Date('Dec 25 2013 00:00:00 UTC')], // exclude these dates
excludeTimezone: 'Europe/Berlin' // timezone of exclude
});Recurrence date as Date object.
Appointment summary, defaults to empty string.
Appointment description
Some calendar apps may support HTML descriptions. Like in emails, supported HTML tags and styling is limited.
Appointment location
Appointment geo position (gps). See rfc for more details
event.geo({
lat: 44.4987,
lon: -6.87667
});
// OR
event.geo('44.4987;-6.87667');Appointment organizer
event.organizer({
name: 'Organizer\'s Name',
email: '[email protected]'
});
// OR
event.organizer('Organizer\'s Name <[email protected]>');You can also add an explicit mailto email address.
event.organizer({
name: 'Organizer\'s Name',
email: '[email protected]',
mailto: '[email protected]'
})Creates a new Attendee (ICalAttendee) and returns it. Use options to prefill the attendee's attributes.
Calling this method without options will create an empty attendee.
const ical = require('ical-generator');
const cal = ical();
const event = cal.createEvent();
const attendee = event.createAttendee({email: '[email protected]', name: 'Hui'});
// overwrite attendee's email address
attendee.email('[email protected]');
// add another attendee
event.createAttendee('Buh <[email protected]>');As with the organizer, you can also add an explicit mailto address.
event.createAttendee({email: '[email protected]', name: 'Hui', mailto: '[email protected]'});
// overwrite an attendee's mailto address
attendee.mailto('[email protected]');Add Attendees to the event or return all attached attendees.
const event = ical().createEvent();
cal.attendees([
{email: '[email protected]', name: 'Person A'},
{email: '[email protected]', name: 'Person B'}
]);
cal.attendees(); // --> [ICalAttendee, ICalAttendee]Creates a new Alarm (ICalAlarm) and returns it. Use options to prefill the alarm's attributes.
Calling this method without options will create an empty alarm.
const ical = require('ical-generator');
const cal = ical();
const event = cal.createEvent();
const alarm = event.createAlarm({type: 'display', trigger: 300});
// add another alarm
event.createAlarm({
type: 'audio',
trigger: 300, // 5min before event
});Add alarms to the event or return all attached alarms.
const event = ical().createEvent();
cal.alarms([
{type: 'display', trigger: 600},
{type: 'audio', trigger: 300}
]);
cal.attendees(); // --> [ICalAlarm, ICalAlarm]Creates a new Category (ICalCategory) and returns it. Use options to prefill the categories' attributes.
Calling this method without options will create an empty category.
const ical = require('ical-generator');
const cal = ical();
const event = cal.createEvent();
const category = event.createCategory({name: 'APPOINTMENT'});
// add another alarm
event.createCategory({
name: 'MEETING'
});Add categories to the event or return all selected categories.
const event = ical().createEvent();
cal.categories([
{name: 'APPOINTMENT'},
{name: 'MEETING'}
]);
cal.categories(); // --> [ICalCategory, ICalCategory]Appointment URL
Appointment status. May be any of the following: confirmed, tentative, cancelled.
Appointment busystatus. May be any of the following: free, tentative, busy, oof.
Date object of the time the appointment was created.
Date object of the time the appointent was modified last.
Use this method to set the attendee's name.
The attendee's email address. An email address is required for every attendee!
Set the attendee's RSVP expectation. May be one of the following: true, false
Set the attendee's role, defaults to REQ-PARTICIPANT. May be one of the following: chair, req-participant, opt-participant, non-participant
Set the attendee's status. May be one of the following: accepted, tentative, declined, delegated, needs-action (See Section 4.2.12)
Set the attendee's type. May be one of the following: individual, group, resource, room, unknown (See Section 4.2.3)
Creates a new Attendee if the passed object is not already an attendee. Will set the delegatedTo and delegatedFrom attributes.
const cal = ical();
const event = cal.createEvent();
const attendee = cal.createAttendee();
attendee.delegatesTo({email: '[email protected]', name: 'Foo'});Creates a new Attendee if the passed object is not already an attendee. Will set the delegatedTo and delegatedFrom attributes.
const cal = ical();
const event = cal.createEvent();
const attendee = cal.createAttendee();
attendee.delegatesFrom({email: '[email protected]', name: 'Foo'});Use this method to set the alarm type. Right now, audio and display are supported.
Use this method to set the alarm time.
const cal = ical();
const event = cal.createEvent();
const alarm = cal.createAlarm();
alarm.trigger(600); // -> 10 minutes before event starts
alarm.trigger(new Date()); // -> nowUse this method to set the alarm time.
const cal = ical();
const event = cal.createEvent();
const alarm = cal.createAlarm();
alarm.triggerAfter(600); // -> 10 minutes after the event finishes
alarm.triggerAfter(new Date()); // -> nowUse this method to repeat the alarm.
const cal = ical();
const event = cal.createEvent();
// repeat the alarm 4 times every 5 minutes…
cal.createAlarm({
repeat: 4,
interval: 300
});Use this method to set the alarm's interval.
const cal = ical();
const event = cal.createEvent();
// repeat the alarm 4 times every 5 minutes…
cal.createAlarm({
repeat: 4,
interval: 300
});Alarm attachment; used to set the alarm sound if type = audio. Defaults to "Basso".
const cal = ical();
const event = cal.createEvent();
event.createAlarm({
attach: 'https://example.com/notification.aud'
});
// OR
event.createAlarm({
attach: {
uri: 'https://example.com/notification.aud',
mime: 'audio/basic'
}
});Alarm description; used to set the alarm message if type = display. Defaults to the event's summary.
Use this method to set the category name.
npm test
npm run coverage
npm run browser-test
ical-generator uses the node.js fs module to save your calendar on the filesystem. In browser environments, you usually don't need this, so if you pass null for fs in your bundler. In webpack this looks like this:
{
"node": {
"fs": "empty"
}
}Thanks @rally25rs for this tip.
Copyright (c) Sebastian Pekarek under the MIT license.