DailyRecurrenceIterator

A class which provides iteration to call a function for dates specified by a RecurrenceModel over a specified date range.

Functions

1

Iterates over the passed date range, calling the passed callback on each date on which starts a recurring event which matches the passed recurrence rule and overlaps the start and end dates and is not an exceptionDate in the recurring event.

ParameterTypeDescription
configObject

An object which describes how to iterate.

config.startDateDate

The point in time to begin iteration.

config.endDateDate

The point in time to end iteration.

config.startOnlyBoolean

By default, all occurrences which intersect the date range will be visited. Pass true to only visit occurrences which start in the date range.

config.recurrenceRecurrenceModel

The point in time to end iteration.

config.fnfunction

The function to call for each date which matches the recurrence in the date range.

config.fn.dateDate

The occurrence date.

config.fn.counterNumber

A counter of how many dates have been visited in this iteration.

config.fn.isFirstBoolean

A flag which is true if the date is the first occurrence in the specified recurrence rule.

config.extraArgsArray

Extra arguments to pass to the callback after the isFirst argument.