Gathering detailed insights and metrics for ical-generator
Gathering detailed insights and metrics for ical-generator
Gathering detailed insights and metrics for ical-generator
Gathering detailed insights and metrics for ical-generator
ics
iCal (ics) file generator
@flowr-es/ical-generator
ical-generator is a small piece of code which generates ical calendar files
timezones-ical-library
Easy direct access to the most recent official timezone information for iCalendar files via JavaScript
ical-toolkit
ICal generator/updater/parser with Timezone/DST, Alams, Organizers, Events, etc. support.
ical-generator is a small piece of code which generates ical calendar files
npm install ical-generator
Typescript
Module System
Min. Node Version
Node Version
NPM Version
84.6
Supply Chain
83.8
Quality
93.8
Maintenance
100
Vulnerability
99.6
License
v8.0.2-develop.6
Published on 28 Nov 2024
v8.0.2-develop.5
Published on 19 Nov 2024
v8.0.2-develop.4
Published on 12 Nov 2024
v8.0.2-develop.3
Published on 05 Nov 2024
v8.0.2-develop.2
Published on 29 Oct 2024
v8.0.2-develop.1
Published on 22 Oct 2024
Updated on 05 Dec 2024
Minified
Minified + Gzipped
TypeScript (98.91%)
JavaScript (0.9%)
CSS (0.2%)
Cumulative downloads
Total Downloads
Last day
20.7%
Compared to previous day
Last week
-3.2%
Compared to previous week
Last month
-1.9%
Compared to previous month
Last year
35.8%
Compared to previous year
1
8
34
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.
npm install ical-generator
1import ical, {ICalCalendarMethod} from 'ical-generator'; 2import http from 'node:http'; 3 4const calendar = ical({name: 'my first iCal'}); 5 6// A method is required for outlook to display event as an invitation 7calendar.method(ICalCalendarMethod.REQUEST); 8 9const startTime = new Date(); 10const endTime = new Date(); 11endTime.setHours(startTime.getHours()+1); 12calendar.createEvent({ 13 start: startTime, 14 end: endTime, 15 summary: 'Example Event', 16 description: 'It works ;)', 17 location: 'my room', 18 url: 'http://sebbo.net/' 19}); 20 21http.createServer((req, res) => { 22 res.writeHead(200, { 23 'Content-Type': 'text/calendar; charset=utf-8', 24 'Content-Disposition': 'attachment; filename="calendar.ics"' 25 }); 26 27 res.end(calendar.toString()); 28}).listen(3000, '127.0.0.1', () => { 29 console.log('Server running at http://127.0.0.1:3000/'); 30});
See the examples folder for more examples.
ical-generator supports native Date,
Day.js, Luxon's DateTime
and the older moment.js and moment-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:
1import {ICalCalendar} from 'ical-generator'; 2import {getVtimezoneComponent} from '@touch4it/ical-timezones'; 3 4const cal = new ICalCalendar(); 5cal.timezone({ 6 name: 'FOO', 7 generator: getVtimezoneComponent 8}); 9cal.createEvent({ 10 start: new Date(), 11 timezone: 'Europe/London' 12});
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.
npm test
npm run coverage
It's here. If you need the changelog for
ical-generator
1.x.x and older, you'll find it here.
ReferenceError: TextEncoder is not defined
error (in some browsers)This library uses TextEncoder
, which
is available in node.js ≥ 11.0.0 and all modern browsers.
Outdated browsers may not have the necessary API and generate this error when generating the calendar.
Copyright (c) Sebastian Pekarek under the MIT license.
No vulnerabilities found.
Reason
30 commit(s) and 4 issue activity found in the last 90 days -- score normalized to 10
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
Reason
packaging workflow detected
Details
Reason
4 existing vulnerabilities detected
Details
Reason
dependency not pinned by hash detected -- score normalized to 4
Details
Reason
Found 0/9 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More