Skip to content

Commit

Permalink
deploy: c68282f
Browse files Browse the repository at this point in the history
  • Loading branch information
@kewisch
kewisch committed Jun 17, 2024
1 parent 1696c6c commit 5186876
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions api/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="ICAL.module_TimezoneService.html">TimezoneService</a></div><div class="sidebar-section-children"><a href="ICAL.module_design.html">design</a></div><div class="sidebar-section-children"><a href="ICAL.module_design.html">design</a></div><div class="sidebar-section-children"><a href="ICAL.module_helpers.html">helpers</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="ICAL.Binary.html">Binary</a></div><div class="sidebar-section-children"><a href="ICAL.Component.html">Component</a></div><div class="sidebar-section-children"><a href="ICAL.ComponentParser.html">ComponentParser</a></div><div class="sidebar-section-children"><a href="ICAL.Duration.html">Duration</a></div><div class="sidebar-section-children"><a href="ICAL.Event.html">Event</a></div><div class="sidebar-section-children"><a href="ICAL.Period.html">Period</a></div><div class="sidebar-section-children"><a href="ICAL.Property.html">Property</a></div><div class="sidebar-section-children"><a href="ICAL.Recur.html">Recur</a></div><div class="sidebar-section-children"><a href="ICAL.RecurExpansion.html">RecurExpansion</a></div><div class="sidebar-section-children"><a href="ICAL.RecurIterator.html">RecurIterator</a></div><div class="sidebar-section-children"><a href="ICAL.Time.html">Time</a></div><div class="sidebar-section-children"><a href="ICAL.Timezone.html">Timezone</a></div><div class="sidebar-section-children"><a href="ICAL.UtcOffset.html">UtcOffset</a></div><div class="sidebar-section-children"><a href="ICAL.VCardTime.html">VCardTime</a></div><div class="sidebar-section-children"><a href="ICAL.parse.ParserError.html">ParserError</a></div><div class="sidebar-section-children"><a href="InvalidRecurrenceRuleError.html">InvalidRecurrenceRuleError</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-namespaces"><div>Namespaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="ICAL.html">ICAL</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section class="readme"><article><h1 id="ical.js---javascript-parser-for-icalendar%2C-jcal%2C-vcard%2C-jcard.">ical.js - Javascript parser for iCalendar, jCal, vCard, jCard.</h1><p>This is a library to parse the formats defined in the following rfcs and their extensions:</p><ul><li><a href="http://tools.ietf.org/html/rfc5545">rfc 5545</a> (iCalendar)</li><li><a href="http://tools.ietf.org/html/rfc7265">rfc7265</a> (jCal)</li><li><a href="http://tools.ietf.org/html/rfc6350">rfc6350</a> (vCard)</li><li><a href="http://tools.ietf.org/html/rfc7095">rfc7095</a> (jCard)</li></ul><p>The initial goal was to use it as a replacement for libical in the <a href="http://www.mozilla.org/projects/calendar/">Mozilla Calendar Project</a>, but the library has been written with the web in mind. This library enables you to do all sorts of cool experiments with calendar data and the web. Most algorithms here were taken from <a href="https://github.com/libical/libical">libical</a>. If you are bugfixing this library, please check if the fix can be upstreamed to libical.</p><p><img src="https://github.com/kewisch/ical.js/workflows/Checkin/badge.svg" alt="Build Status"> <a href="https://coveralls.io/r/kewisch/ical.js"><img src="https://coveralls.io/repos/kewisch/ical.js/badge.svg" alt="Coverage Status"></a><a href="http://badge.fury.io/js/ical.js"><img src="https://badge.fury.io/js/ical.js.svg" alt="npm version"></a><a href="https://cdnjs.com/libraries/ical.js"><img src="https://img.shields.io/cdnjs/v/ical.js.svg" alt="CDNJS"></a></p><h2 id="sandbox-and-validator">Sandbox and Validator</h2><p>If you want to try out ICAL.js right now, there is a <a href="http://jsfiddle.net/kewisch/227efboL/">jsfiddle</a> set up and ready to use.</p><p>The ICAL validator demonstrates how to use the library in a webpage, and helps verify iCalendar and jCal. <a href="http://kewisch.github.io/ical.js/validator.html">Try the validator online</a></p><p>The recurrence tester calculates occurrences based on a RRULE. It can be used to aid in creating test cases for the recurrence iterator. <a href="https://kewisch.github.io/ical.js/recur-tester.html">Try the recurrence tester online</a>.</p><h2 id="installing">Installing</h2><p>ICAL.js has no dependencies and is written in modern JavaScript. You can install ICAL.js via <a href="https://www.npmjs.com/">npm</a>, if you would like to use it in Node.js:</p><pre class="prettyprint source lang-bash"><code>npm install ical.js
</code></pre><p>Then simply import it for use:</p><pre class="prettyprint source lang-javascript"><code>import ICAL from &quot;ical.js&quot;;
</code></pre><p>If you are working with a browser, be aware this is an ES6 module:</p><pre class="prettyprint source lang-html"><code>&lt;script type=&quot;module&quot;>
import ICAL from &quot;https://unpkg.com/ical.js&quot;;
import ICAL from &quot;https://unpkg.com/ical.js/dist/ical.min.js&quot;;
document.querySelector(&quot;button&quot;).addEventListener(&quot;click&quot;, () => {
ICAL.parse(document.getElementById(&quot;txt&quot;).value);
});
&lt;/script>
</code></pre><p>If you need to make use of a script tag, you can use the transpiled ES5 version:</p><pre class="prettyprint source lang-html"><code>&lt;script src=&quot;https://unpkg.com/ical.js/dist/ical.es5.cjs&quot;>&lt;/script>
</code></pre><p>If you need to make use of a script tag, you can use the transpiled ES5 version:</p><pre class="prettyprint source lang-html"><code>&lt;script src=&quot;https://unpkg.com/ical.js/dist/ical.es5.min.cjs&quot;>&lt;/script>
&lt;textarea id=&quot;txt&quot;>&lt;/textarea>
&lt;button onclick=&quot;ICAL.parse(document.getElementById('txt').value)&quot;>&lt;/button>
</code></pre><h2 id="timezones">Timezones</h2><p>The stock ical.js does not register any timezones, due to the additional size it brings. If you'd like to do timezone conversion, and the timezone definitions are not included in the respective ics files, you'll need to use <code>ical.timezones.js</code> or its minified counterpart.</p><p>This file is not included in the distribution since it pulls in IANA timezones that might change regularly. See the github actions on building your own timezones during CI, or grab a recent build from main.</p><h2 id="documentation">Documentation</h2><p>For a few guides with code samples, please check out <a href="https://github.com/kewisch/ical.js/wiki">the wiki</a>. If you prefer, full API documentation <a href="http://kewisch.github.io/ical.js/api/">is available here</a>. If you are missing anything, please don't hesitate to create an issue.</p><h2 id="developing">Developing</h2><p>To contribute to ICAL.js you need to set up the development environment. A simple <code>npm install</code> will get you set up. If you would like to help out and would like to discuss any API changes, please feel free to create an issue.</p><h3 id="tests">Tests</h3><p>The following test suites are available</p><pre><code>npm run test-unit # Node unit tests
</code></pre><p>The browser examples above use the minified versions of the library, which is probably what you want. However, there are also unminified versions of ICAL.js available on unpkg.</p><ul><li>Unminified ES6 module: <code>https://unpkg.com/ical.js/dist/ical.js</code></li><li>Unminified ES5 version: <code>https://unpkg.com/ical.js/dist/ical.es5.cjs</code></li></ul><h2 id="timezones">Timezones</h2><p>The stock ical.js does not register any timezones, due to the additional size it brings. If you'd like to do timezone conversion, and the timezone definitions are not included in the respective ics files, you'll need to use <code>ical.timezones.js</code> or its minified counterpart.</p><p>This file is not included in the distribution since it pulls in IANA timezones that might change regularly. See the github actions on building your own timezones during CI, or grab a recent build from main.</p><h2 id="documentation">Documentation</h2><p>For a few guides with code samples, please check out <a href="https://github.com/kewisch/ical.js/wiki">the wiki</a>. If you prefer, full API documentation <a href="http://kewisch.github.io/ical.js/api/">is available here</a>. If you are missing anything, please don't hesitate to create an issue.</p><h2 id="developing">Developing</h2><p>To contribute to ICAL.js you need to set up the development environment. A simple <code>npm install</code> will get you set up. If you would like to help out and would like to discuss any API changes, please feel free to create an issue.</p><h3 id="tests">Tests</h3><p>The following test suites are available</p><pre><code>npm run test-unit # Node unit tests
npm run test-acceptance # Node acceptance tests
npm run test-performance # Performance comparison tests
npm run test-browser # Browser unit and acceptance tests
Expand Down

0 comments on commit 5186876

Please sign in to comment.