Constructor
new RecurIterator(options)
Creates a new ICAL.RecurIterator instance. The options object may contain additional members when resuming iteration from a previous run.
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options | Object | The iterator options Properties
|
- Source
Members
completed :Boolean
True when iteration is finished.
- Boolean
- Source
dtstart :ICAL.Time
The start date of the event being iterated.
- Source
last :ICAL.Time
The last occurrence that was returned from the RecurIterator#next method.
- Source
occurrence_number :Number
The sequence number from the occurrence
- Number
- Source
rule :ICAL.Recur
The rule that is being iterated
- Source
Methods
fromData(options)
Initialize the recurrence iterator from the passed data object. This method is usually not called directly, you can initialize the iterator through the constructor.
| Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options | Object | The iterator options Properties
|
- Source
next() → {ICAL.Time}
Retrieve the next occurrence from the iterator.
- Source
- Type:
- ICAL.
Time
ruleDayOfWeek(dow, aWeekStartopt)
| Name | Type | Attributes | Description |
|---|---|---|---|
dow | (eg: '1TU', '-1MO') | ||
aWeekStart | ICAL. | <optional> | The week start weekday |
- Source
[pos, numericDow] (eg: [1, 3]) numericDow is relative to aWeekStart
toJSON() → {Object}
Convert iterator into a serialize-able object. Will preserve current iteration sequence to ensure the seamless continuation of the recurrence rule.
- Source
- Type:
- Object