v2 documentation
The iCalendar generator.
v2 has been released! v1 is no longer actively supported, but you can find the documentation here.
npm install -S ics
- Create an iCalendar event:
import ics from 'ics'
const attributes = {
start: [2018, 5, 30, 6, 50],
duration: { hours: 6, minutes: 30 },
title: 'Bolder Boulder',
description: 'Annual 10-kilometer run in Boulder, Colorado',
location: 'Folsom Field, University of Colorado (finish line)',
url: 'http://www.bolderboulder.com/',
status: 'CONFIRMED',
geo: { lat: 40.0095, lon: 105.2669 },
attendees: [
{ name: 'Adam Gibbons', email: '[email protected]' },
{ name: 'Brittany Seaton', email: '[email protected]' }
],
categories: ['10k races', 'Memorial Day Weekend', 'Boulder CO'],
alarms: [{
action: 'display',
trigger: [2018, 5, 29, 20, 0],
description: 'Reminder'
}]
}
ics.createEvent(attributes, (error, value) => {
if (err) {
console.log(err)
}
console.log(value)
// BEGIN:VCALENDAR
// VERSION:2.0
// CALSCALE:GREGORIAN
// PRODID:adamgibbons/ics
// BEGIN:VEVENT
// UID:74c63d40-a784-11e7-a9ec-bd33b9a01c41
// SUMMARY:Bolder Boulder
// DTSTAMP:20171002T211400Z
// DTSTART:20180530T125000Z
// DESCRIPTION:Annual 10-kilometer run in Boulder, Colorado
// URL:http://www.bolderboulder.com/
// GEO:40.0095;105.2669
// LOCATION:Folsom Field, University of Colorado (finish line)
// STATUS:CONFIRMED
// CATEGORIES:10k races,Memorial Day Weekend,Boulder CO
// ATTENDEE;CN=Adam Gibbons:mailto:[email protected]
// ATTENDEE;CN=Brittany Seaton:mailto:[email protected]
// BEGIN:VALARM
// ACTION:display
// DESCRIPTION:Reminder
// TRIGGER;VALUE=DATE-TIME:20180530T020000Z
// END:VALARM
// DURATION:PT6H30M
// END:VEVENT
// END:VCALENDAR
})- Write an iCalendar file:
import { writeFileSync } from 'fs'
import ics from 'ics'
ics.createEvent({
title: 'Dinner',
description: 'Nightly thing I do',
start: [2018, 1, 15, 6, 30],
duration: { minutes: 50 }
}, (error, value) => {
if (error) {
console.log(error)
}
fs.writeFileSync(`${__dirname}/event.ics`, value)
})Returns an iCal-compliant text string. If callback is provided, returns a Node-style callback. If callback is not provided, returns an object with error and value properties.
Object literal containing event information.
Only the start property is required.
The following properties are accepted:
| Property | Description | Example |
|---|---|---|
| start | Required. Date and time in your timezone at which the event begins. |
[2000, 1, 5, 10, 0] (January 5, 2000 at 10am in your timezone) |
| end | Time at which event ends. Either end or duration is required, but not both. |
[2000, 1, 5, 13, 5] (January 5, 2000 at 1pm) |
| duration | How long the event lasts. Object literal having form { weeks, days, hours, minutes, seconds } Either end or duration is required, but not both. |
{ hours: 1, minutes: 45 } (1 hour and 45 minutes) |
| title | Title of event. | 'Code review' |
| description | Description of event. | 'A constructive roasting of those seeking to merge into master branch' |
| location | Intended venue |
Mountain Sun Pub and Brewery. |
| geo | Geographic coordinates (lat/lon) | { lat: 38.9072, lon: 77.0369 } |
| url | URL associated with event | 'http://www.mountainsunpub.com/' |
| status | Three statuses are allowed: tentative, confirmed, or cancelled
|
confirmed |
| organizer | Person organizing the event | {name: 'Adam Gibbons', email: '[email protected]'} |
| attendees | Persons invited to the event | [{ name: 'Mo', email: '[email protected]'}, { name: 'Bo', email: '[email protected]' }] |
| categories | Categories associated with the event | ['hacknight', 'stout month'] |
| alarms | Alerts that can be set to trigger before, during, or after the event | { action: 'DISPLAY', trigger: '-PT30M' } |
Optional. Node-style callback.
function (err, value) {
if (err) {
// if iCal generation fails, err is an object containing the reason
// if iCal generation succeeds, err is null
}
console.log(value) // iCal-compliant text string
}
Run mocha tests and watch for changes:
npm start
Run tests once and exit:
npm test
Build the project, compiling all ES6 files within the src directory into vanilla JavaScript in the dist directory.
npm run build