icalevent

Create an iCalEvent instance by setting limited properties and get an ics formatted string.

iCalEvent

Create an iCalEvent instance by setting limited properties and event.toFile() to get an ics formatted string back.

With npm:

npm install icalevent
var iCalEvent = require('icalevent');
 
var event = new iCalEvent({
    uid: 9873647,
    offset: new Date().getTimezoneOffset(),
    method: 'request',
    status: 'confirmed',
    attendees: [
        {
            name: 'Johnny Boy',
            email: 'johnny@numberfive.com'
        },
        {
            name: 'Homer Simpson',
            email: 'homer@powerplant.com'
        }
    ],
    start: '2014-07-01T02:00:00-05:00',
    end: '2014-07-01T02:30:00-05:00',
    timezone: 'US/Central',
    summary: 'Priestly Duties',
    description: 'Home flu visit.',
    location: 'Casa',
    organizer: {
        name: 'Nacho Libre',
        email: 'luchador@monastery.org'
    },
    url: 'http://google.com/search?q=nacho+libre'
});

Or:

var iCalEvent = require('icalevent');
 
var event = new iCalEvent();
 
event.set('uid', 9873647);
event.set('offset', new Date().getTimezoneOffset());
event.set('method', 'request');
event.set('status', 'confirmed');
event.set('attendees', [
    {
        name: 'Johnny Boy',
        email: 'johnny@numberfive.com'
    },
    {
        name: 'Homer Simpson',
        email: 'homer@powerplant.com'
    }
]);
event.set('start', '2014-07-01T02:00:00-05:00');
event.set('end', '2014-07-01T02:30:00-05:00');
event.set('timezone', 'US/Central');
event.set('summary', 'Priestly Duties.');
event.set('description', 'Home flu visit.');
event.set('location', 'Casa');
event.set('organizer', { name: 'Nacho Libre', email: 'luchador@monastery.org' });
event.set('url', 'http://google.com/search?q=nacho+libre');

To ics string:

event.toFile();

Returns:

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//iCalEvent.js v0.3//EN
BEGIN:VEVENT
UID:9873647
DTSTAMP:20140316T003036
METHOD:REQUEST
STATUS:CONFIRMED
DTSTART;TZID=US/Central:20140701T020000
DTEND;TZID=US/Central:20140701T023000
SUMMARY:Priestly Duties.
DESCRIPTION:Home flu visit.
ORGANIZER;CN=Nacho Libre:mailto:luchador@monastery.org
LOCATION:Casa
URL;VALUE=URI:http://google.com/search?q=nacho+libre
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;CN=Johnny Boy:MAILTO:johnny@numberfive.com
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;CN=Homer Simpson:MAILTO:homer@powerplant.com
END:VEVENT
END:VCALENDAR
  • offset (Integer) The Date.getTimezoneOffset() of the timezone the event is set in. Important: the offset has to be set before start and end times
  • start (Date Object) The start date object of the event
  • end (Date Object) The end date object of the event
  • uid (String or Integer) The event uid. If you don't set the uid it will be set for you.
  • method (String) The event method. For example, publish, request, reply, add, cancel, refresh, counter, and decline-counter
  • status (String) The event status. For example, cancelled, confirmed, tentative
  • timezone (String) The event's timezone in ICS timezone format. If you don't set the timezone it will be set for you.
  • location (String) The event location of the event. For example, monastery
  • url (String) A url corresponding to the event
  • summary (String) A summary of the event
  • description (String) A description of the event
  • organizer (Object) The organizer object in the following format:
{
    name: 'Nacho Libre',
    email: 'luchador@monastery.org'
}
  • attendees (Array) The attendees array in the following format:
[
    {
        name: 'Johnny Boy',
        email: 'johnny@numberfive.com'
    },
    {
        name: 'Homer Simpson',
        email: 'homer@powerplant.com'
    }
]
event.set('url', 'http://google.com/search?q=nacho+libre');
event.get('url');

Returns:

http://google.com/search?q=nacho+libre
event.toFile();

Returns:

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//iCalEvent.js v0.3//EN
BEGIN:VEVENT
UID:9873647
DTSTAMP:20140316T003036
METHOD:REQUEST
STATUS:CONFIRMED
DTSTART;TZID=US/Central:20140701T020000
DTEND;TZID=US/Central:20140701T023000
SUMMARY:Priestly Duties.
DESCRIPTION:Home flu visit.
ORGANIZER;CN=Nacho Libre:mailto:luchador@monastery.org
LOCATION:Casa
URL;VALUE=URI:http://google.com/search?q=nacho+libre
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;CN=Johnny Boy:MAILTO:johnny@numberfive.com
ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;PARTSTAT=NEEDS-ACTION;CN=Homer Simpson:MAILTO:homer@powerplant.com
END:VEVENT
END:VCALENDAR

MIT

  • tests