Skip to content

About

Small library that wraps ICAL.js and provides more convenient means for editing

Topics

Resources

Contributing

Security policy

Stars

17 stars

Watchers

4 watching

Forks

Repository files navigation

📅 @nextcloud/calendar-js - Heart of the Nextcloud calendar app

npm Build status Codecov branch

This library is a wrapper for ICAL.js that provides more convenient ways for editing. Together with cdav-library, it's the heart of the Nextcloud calendar app.

Maintainers

Developing

Please take note that this library has been developed solely for the purpose of using it in the Nextcloud calendar app. Feel free to use it in your project, but don't expect any support / bugfixes / features.

Setup

npm ci

Tests

npm run test

Linting

npm run lint

TypeScript definitions

npm run build generates dist/index.d.ts for ES modules and dist/index.d.cts for CommonJS from the JavaScript and JSDoc. Update the JSDoc when changing the API and do not edit the generated files.

Members installed on a prototype by the advertise* helpers are invisible to TypeScript, so each component declares them in a @typedef named <Component>Members above the class. When adding an advertised member, also add it to that typedef.

Run npm run test:types to build and check strict TypeScript consumers with NodeNext (ES modules and CommonJS) and bundler module resolution. To check an existing build, use npm run check:types.

Releases

This repository follows the concept of conventional commits.

Publishing a GitHub release triggers the Publish workflow, which builds and publishes the package to npm. The release tag must match the version in package.json (with an optional v prefix). Publishing uses the npm-publish environment and is subject to its configured protection rules.

License

Calendar-js is licensed under the GNU Affero General Public License, version 3 or later.

About

Small library that wraps ICAL.js and provides more convenient means for editing

Topics

Resources

Contributing

Security policy

Stars

17 stars

Watchers

4 watching

Forks

Releases

Used by

Contributors

Languages