Class RecurExpansion

Primary class for expanding recurring rules. Can take multiple rrules, rdates, exdate(s) and iterate (in order) over each next occurrence.

Once initialized this class can also be serialized saved and continue iteration from the last point.

NOTE: it is intended that this class is to be used with ICAL.Event which handles recurrence exceptions.

Example

// assuming event is a parsed ical component
var event;

var expand = new ICAL.RecurExpansion({
  component: event,
  dtstart: event.getFirstPropertyValue('dtstart')
});

// remember there are infinite rules so it is a good idea to limit the scope of the iterations
// then resume later on.

// next is always an ICAL.Time or null
var next;

while (someCondition && (next = expand.next())) {
  // do something with next
}

// save instance for later
var json = JSON.stringify(expand);

//...

// NOTE: if the component's properties have changed you will need to rebuild the class and start
// over. This only works when the component's recurrence info is the same.
var expand = new ICAL.RecurExpansion(JSON.parse(json));
Copy

Alias

ICAL.RecurExpansion