MonthlyRecurrenceIterator

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

Functions

forEachDatestatic

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

Parameter	Type	Description
`config`	Object	An object which describes how to iterate.
`config.startDate`	Date	The point in time to begin iteration.
`config.endDate`	Date	The point in time to end iteration.
`config.startOnly`	Boolean	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.recurrence`	RecurrenceModel	The point in time to end iteration.
`config.fn`	function	The function to call for each date which matches the recurrence in the date range.
`config.fn.date`	Date	The occurrence date.
`config.fn.counter`	Number	A counter of how many dates have been visited in this iteration.
`config.fn.isFirst`	Boolean	A flag which is `true` if the date is the first occurrence in the specified recurrence rule.
`config.extraArgs`	Array	Extra arguments to pass to the callback after the `isFirst` argument.