Miss any of our Open RFC calls?Watch the recordings here! »

ics2.0

1.0.2 • Public • Published

ICS File Generator

Generate iCalendar files.

npm version Code Climate TravisCI build status

Installation

npm install ics2.0

Usage

Require the module: require('ics').

ics.getEvent(options)

Returns an iCal-compliant text string.

ics.createEvent(options, filepath, cb)

Returns a callback with an iCal-compliant .ics file.

Options:

  • dtstart: (Date string) Event start time. Defaults to current time.
  • dtend: (Date string) Event end time. Defaults to one hour from dtstart.
  • description: (String) Description (details) of the event.
  • eventName: (String) Title of the event as it appears in calendar application
  • filename: (String) Name of the iCal file. Defaults to calendar-event.ics.
  • location: (String) Location of the event.
  • url: (String) Url of website
  • organizer: (Object)
    • name: (String)
    • email: (String)
  • attendees: (Object)
    • name: (String)
    • email: (String)
    • rsvp: (Boolean) Defaults to false.

Example:

var ical = require('ics');
 
var options = {
  eventName: 'Fingerpainting lessons',
  filename: 'event.ics',
  dtstart: 'Sat Nov 02 2014 13:15:00 GMT-0700 (PDT)',
  location: 'Here and there',
  email: {
    name: 'Bob',
    email: 'Bob@Jamaica.com'
  }
};
 
ical.createEvent(options, null, function(err, success) {
  if (err) {
    console.log(err);
  }
 
  console.log(success); // returns filepath
});

The above snippet creates a file named event.ics, saves it to the operating system's temporary directory, and returns the filepath.

The event.ics file should look something like this:

BEGIN:VCALENDAR
VERSION:2.0
BEGIN:VEVENT
DTSTAMP:20150701T170000Z
ORGANIZER;CN=John Doe:MAILTO:john.doe@example.com
DTSTART:20150714T170000Z
DTEND:20150715T035959Z
SUMMARY:Fingerpainting lessons
URL:http://google.com
END:VEVENT
END:VCALENDAR

TODO

References

RFC 5545: Internet Calendaring and Scheduling Core Object Specification (iCalendar)

Initial iCalendar Elements Registries

EXAMPLE

Check out our expressjs example.Follow the instructions below to try it out npm install cd ex node app.js

Then go over to the browser and hit this url http://localhost:3000/create

A file will be created and your can reach it in the browser here localhost:3000/created/example.ics

Install

npm i ics2.0

DownloadsWeekly Downloads

2

Version

1.0.2

License

MIT

Last publish

Collaborators

  • avatar