npmpackage.info

Gathering detailed insights and metrics for @flowr-es/ical-generator

Other packages similar to @flowr-es/ical-generator

@flowr-es/ics

2.33.0

iCal (ics) file generator and parser

Gathering detailed insights and metrics for @flowr-es/ical-generator

@flowr-es/ical-generator - 8.1.1 | npmpackage.info

@flowr-es/ical-generator

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

8.1.1

794

MIT

TypeScript

8.70 kB

3,158 4.1

Installations

npm install @flowr-es/ical-generator

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

18 || 20 || >=22.0.0

Node Version

18.20.4

NPM Version

10.7.0 Score

64.1

Supply Chain

83.3

Quality

82.1

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

1

Total

437

Closed

47

Merged

389

Issues

Open

4

Total

219

Closed

215

Releases

203

v9.0.0-develop.6

Updated on May 08, 2025

v9.0.0-develop.5

Updated on May 06, 2025

v9.0.0-develop.4

Updated on May 06, 2025

v9.0.0-develop.3

Updated on May 05, 2025

v9.0.0-develop.2

Updated on May 03, 2025

v9.0.0-develop.1

Updated on May 01, 2025

View All 203 releases

Languages

TypeScript

JavaScript

CSS

TypeScript (98.98%)

JavaScript (0.85%)

CSS (0.18%)

Developer

sebbo2002

Download Statistics

Total Downloads

3,158

Last Day

Last Week

Last Month

111

Last Year

852

GitHub Statistics

MIT License

794 Stars

1,857 Commits

165 Forks

9 Watchers

3 Branches

71 Contributors

Updated on May 08, 2025

Bundle Size

33.76 kB

Minified

8.70 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 71 Contributors

Package Meta Information

Latest Version

8.1.1

Package Id

@flowr-es/ical-generator@8.1.1

Unpacked Size

755.09 kB

Size

143.07 kB

File Count

NPM Version

10.7.0

Node Version

18.20.4

Published on

Apr 16, 2025

Total Downloads

Cumulative downloads

Total Downloads

3,158

Last Day

Compared to previous day

Last Week

120%

Compared to previous week

Last Month

8.8%

111

Compared to previous month

Last Year

-35.5%

852

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependency Status

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.

FORKED contains timezones array for calendars - version is more or less the original version

📦 Installation

npm install ical-generator

⚡️ Quick Start

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.

📑 API-Reference

Index
- ICalCalendar
- ICalEvent

🕒 Date, Time & Timezones

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.

🚦 Tests

npm test
npm run coverage

🙋 FAQ

Where's the changelog?

It's here. If you need the changelog for ical-generator 1.x.x and older, you'll find it here.

I get a `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 and license

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 4

Details

Warn: third-party GitHubAction not pinned by hash: .github/workflows/dependabot-auto-merge.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/dependabot-auto-merge.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/is-semantic-pr.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/is-semantic-pr.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/lock-issues.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/lock-issues.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-bot.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/release-bot.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-bot.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/release-bot.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release-bot.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/release-bot.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale-issues.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/stale-issues.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/template-updater.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/template-updater.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-release.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/test-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-release.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/test-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-release.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/test-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-release.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/test-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-release.yml:83: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/test-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-release.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/test-release.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test-release.yml:103: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/test-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-release.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/test-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-release.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/sebbo2002/ical-generator/test-release.yml/develop?enable=pin
Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 5 third-party GitHubAction dependencies pinned
Info: 5 out of 5 npmCommand dependencies pinned

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.1

/10

Last Scanned on 2025-04-28

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

Other packages similar to @flowr-es/ical-generator

Other packages similar to @flowr-es/ical-generator

@flowr-es/ical-generator

Installations

Developer Guide

Yes

ESM

18 || 20 || >=22.0.0

18.20.4

10.7.0

Score

Pull Requests

1

437

47

389

Issues

4

219

215

Releases

Languages

Developer

sebbo2002

Download Statistics

GitHub Statistics

Bundle Size

33.76 kB

8.70 kB

Maintainers

Package Meta Information

Total Downloads

3,158

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

FORKED contains timezones array for calendars - version is more or less the original version

📦 Installation

⚡️ Quick Start

📑 API-Reference

🕒 Date, Time & Timezones

🚦 Tests

🙋 FAQ

Where's the changelog?

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

🙆🏼‍♂️ Copyright and license

10

10

10

10

10

4

1

0

0

0

0

0

0

0

4.1

/10

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