https://github.com/sebbo2002/ical-generator

ical-generator is a small piece of code which generates ical calendar files
https://github.com/sebbo2002/ical-generator

Last synced: 7 days ago
JSON representation

ical-generator is a small piece of code which generates ical calendar files

• Host: GitHub
• URL: https://github.com/sebbo2002/ical-generator
• Owner: sebbo2002
• License: mit
• Created: 2013-03-09T22:30:46.000Z (over 11 years ago)
• Default Branch: develop
• Last Pushed: 2024-10-29T08:51:32.000Z (14 days ago)
• Last Synced: 2024-10-29T10:01:53.817Z (14 days ago)
• Language: TypeScript
• Size: 21.3 MB
• Stars: 744
• Watchers: 11
• Forks: 162
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - sebbo2002/ical-generator - ical-generator is a small piece of code which generates ical calendar files (TypeScript)

README

        








  

    

  

  

    

  





    

    

    

    

    






`ical-generator` is a small but fine library with which you can very easily create a valid iCal calendars, for example

to generate subscriptionable calendar feeds.

## 📦 Installation

	npm install ical-generator

## ⚡️ Quick Start

```javascript

import ical, {ICalCalendarMethod} from 'ical-generator';

import http from 'node:http';

const calendar = ical({name: 'my first iCal'});

// A method is required for outlook to display event as an invitation

calendar.method(ICalCalendarMethod.REQUEST);

const startTime = new Date();

const endTime = new Date();

endTime.setHours(startTime.getHours()+1);

calendar.createEvent({

    start: startTime,

    end: endTime,

    summary: 'Example Event',

    description: 'It works ;)',

    location: 'my room',

    url: 'http://sebbo.net/'

});

http.createServer((req, res) => {

    res.writeHead(200, {

        'Content-Type': 'text/calendar; charset=utf-8',

        'Content-Disposition': 'attachment; filename="calendar.ics"'

    });

    res.end(calendar.toString());

}).listen(3000, '127.0.0.1', () => {

    console.log('Server running at http://127.0.0.1:3000/');

});

```

See the [examples](https://github.com/sebbo2002/ical-generator/tree/develop/examples) folder for more examples.

## 📑 API-Reference

- [Index](https://sebbo2002.github.io/ical-generator/develop/reference/)

    - [ICalCalendar](https://sebbo2002.github.io/ical-generator/develop/reference/classes/ICalCalendar.html)

    - [ICalEvent](https://sebbo2002.github.io/ical-generator/develop/reference/classes/ICalEvent.html)

        - [ICalAlarm](https://sebbo2002.github.io/ical-generator/develop/reference/classes/ICalAlarm.html)

        - [ICalAttendee](https://sebbo2002.github.io/ical-generator/develop/reference/classes/ICalAttendee.html)

        - [ICalCategory](https://sebbo2002.github.io/ical-generator/develop/reference/classes/ICalCategory.html)

## 🕒 Date, Time & Timezones

ical-generator supports [native Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date),

[Day.js](https://day.js.org/en/), [Luxon's](https://moment.github.io/luxon/) [DateTime](https://moment.github.io/luxon/docs/class/src/datetime.js~DateTime.html)

and the older [moment.js](https://momentjs.com/) and [moment-timezone](https://momentjs.com/timezone/)

objects. You can also pass a string which is then passed to javascript's `Date` internally.

It is recommended to use UTC time as far as possible. `ical-generator` will output all time information as UTC time as

long as no time zone is defined. For day.js, a plugin is necessary for this, which is a prerequisite. If a time zone is

set, `ical-generator` assumes that the given time matches the time zone. If a time zone is used, it is also recommended

to use a VTimezone generator. Such a function generates a VTimezone entry and returns it. For example, ical-timezones can

be used for this:

```typescript

import {ICalCalendar} from 'ical-generator';

import {getVtimezoneComponent} from '@touch4it/ical-timezones';

const cal = new ICalCalendar();

cal.timezone({

    name: 'FOO',

    generator: getVtimezoneComponent

});

cal.createEvent({

    start: new Date(),

    timezone: 'Europe/London'

});

```

If a `moment-timezone` object or Luxon's `setZone` method works, `ical-generator` sets it according to the time zone set

in the calendar/event.

## 🚦 Tests

```

npm test

npm run coverage

```

## 🙋 FAQ

### Where's the changelog?

It's [here](https://github.com/sebbo2002/ical-generator/blob/develop/CHANGELOG.md). If you need the changelog for

`ical-generator` 1.x.x and older, you'll find it [here](https://github.com/sebbo2002/ical-generator/blob/25338b8bf98f9afd3c88849e735fa33fa45fb766/CHANGELOG.md).

### I get a `ReferenceError: TextEncoder is not defined` error (in some browsers)

This library uses [`TextEncoder`](https://developer.mozilla.org/en-US/docs/Web/API/TextEncoder), which

is available in node.js ≥ 11.0.0 and [all modern browsers](https://caniuse.com/?search=textencoder).

Outdated browsers may not have the necessary API and generate this error when generating the calendar.

## 🙆🏼‍♂️ Copyright and license

Copyright (c) Sebastian Pekarek under the [MIT license](LICENSE).