ICAL

The main ICAL module. Provides access to everything else.

Properties
NameTypeDescription
designICAL.design
helpersICAL.helpers

Classes

Binary
Component
ComponentParser
Duration
Event
Period
Property
Recur
RecurExpansion
RecurIterator
Time
Timezone
UtcOffset
VCardTime

Methods

(static) parse(input) → {Object|Array.<Object>}

Parses iCalendar or vCard data into a raw jCal object. Consult documentation on the layers|layers of parsing for more details.

Parameters:
NameTypeDescription
inputString

The string data to parse

To Do
  • Fix the API to be more clear on the return type
Returns:

A single jCal object, or an array thereof

Type: 
Object | Array.<Object>

(static) stringify(jCal) → {String}

Convert a full jCal/jCard array into a iCalendar/vCard string.

Parameters:
NameTypeDescription
jCalArray

The jCal/jCard document

Returns:

The stringified iCalendar/vCard document

Type: 
String