npmpackage.info

@flowr-es/ical-generator

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

5.1.6

759

MIT

TypeScript

701.99 kB

2,862 4.6

Installations

npm install @flowr-es/ical-generator

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

^16.0.0 || >=18.0.0

Node Version

16.20.2

NPM Version

8.19.4 Score

59.6

Supply Chain

83.2

Quality

Maintenance

100

Vulnerability

99.6

License

Pull Requests

Open

2

Total

418

Closed

46

Merged

370

Issues

Open

4

Total

211

Closed

207

Releases

181

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

View all 181 releases

Contributors

View all 68 contributors

Languages

TypeScript

JavaScript

CSS

TypeScript (98.91%)

JavaScript (0.9%)

CSS (0.2%)

Developer

sebbo2002

Download Statistics

Total Downloads

2,862

Last Day

Last Week

Last Month

Last Year

791

GitHub Statistics

759 Stars

1,775 Commits

160 Forks

11 Watching

4 Branches

68 Contributors

Maintainers

Package Meta Information

Latest Version

5.1.6

Package Id

@flowr-es/ical-generator@5.1.6

Unpacked Size

701.99 kB

Size

136.29 kB

File Count

NPM Version

8.19.4

Node Version

16.20.2

Publised On

08 Nov 2023

Total Downloads

Cumulative downloads

Total Downloads

2,862

Last day

Compared to previous day

Last week

500%

Compared to previous week

Last month

88%

Compared to previous month

Last year

-42.9%

791

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

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

# For TypeScript Users
# (see "I use Typescript and get TS2307: Cannot find module errors" section below)
npm i -D @types/node rrule moment-timezone moment dayjs @types/luxon

⚡️ Quick Start

1import ical from 'ical-generator';
2import http from 'node:http';
3
4const calendar = ical({name: 'my first iCal'});
5const startTime = new Date();
6const endTime = new Date();
7endTime.setHours(startTime.getHours()+1);
8calendar.createEvent({
9    start: startTime,
10    end: endTime,
11    summary: 'Example Event',
12    description: 'It works ;)',
13    location: 'my room',
14    url: 'http://sebbo.net/'
15});
16
17http.createServer((req, res) => calendar.serve(res))
18    .listen(3000, '127.0.0.1', () => {
19        console.log('Server running at http://127.0.0.1:3000/');
20    });

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 ical 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
npm run browser-test

🙋 FAQ

What's `Error: Can't resolve 'fs'`?

ical-generator uses the node.js fs module to save your calendar on the filesystem. In browser environments, you usually don't need this, so if you pass null for fs in your bundler. In webpack this looks like this:

1{
2  "resolve": {
3    "fallback": {
4      "fs": false
5    }
6  }
7}

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.

6

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

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: 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: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
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
Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 4 third-party GitHubAction dependencies pinned
Info: 5 out of 5 npmCommand dependencies pinned

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.6

/10

Last Scanned on 2024-12-16

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

@flowr-es/ics

2.33.0

iCal (ics) file generator and parser

@flowr-es/ical-generator

Installations

Developer Guide

Yes

ESM

^16.0.0 || >=18.0.0

16.20.2

8.19.4

Score

Pull Requests

2

418

46

370

Issues

4

211

207

Releases

Contributors

Languages

Developer

sebbo2002

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

2,862

Daily Downloads

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

What's Error: Can't resolve 'fs'?

Where's the changelog?

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

🙆🏼‍♂️ Copyright and license

10

10

10

10

10

6

4

0

0

0

0

0

0

0

4.6

/10

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

What's `Error: Can't resolve 'fs'`?

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