| Option | \nDescription | \n
|---|---|
freq | \n \n (required) One of the following constants: \n
| \n
dtstart | \n The recurrence start. Besides being the base for the\n recurrence, missing parameters in the final recurrence\n instances will also be extracted from this date. If not\n given, new Date will be used instead.\n **IMPORTANT:** See the discussion under timezone support\n | \n
interval | \n The interval between each freq iteration. For example,\n when using RRule.YEARLY, an interval of 2 means\n once every\n two years, but with RRule.HOURLY, it means once every two\n hours.\n The default interval is 1.\n | \n
wkst | \n The week start day. Must be one of the RRule.MO,\n RRule.TU, RRule.WE constants, or an integer,\n specifying\n the first day of the week. This will affect recurrences based\n on weekly periods. The default week start is RRule.MO.\n | \n
count | \n How many occurrences will be generated. | \n
until | \n If given, this must be a Date instance, that will specify\n the limit of the recurrence. If a recurrence instance happens\n to be the same as the Date instance given in the\n until\n argument, this will be the last occurrence.\n | \n
tzid | \n If given, this must be a IANA string recognized by the Intl API. See\n discussion under Timezone support.\n | \n
bysetpos | \n If given, it must be either an integer, or an array of\n integers, positive or negative. Each given integer will specify\n an occurrence number, corresponding to the nth occurrence of\n the rule inside the frequency period. For example, a\n bysetpos of -1 if combined with a RRule.MONTHLY\n frequency, and a byweekday of (RRule.MO, RRule.TU,\n RRule.WE, RRule.TH, RRule.FR), will result in\n the last\n work day of every month.\n | \n
bymonth | \n If given, it must be either an integer, or an array of\n integers, meaning the months to apply the recurrence to.\n | \n
bymonthday | \n If given, it must be either an integer, or an array of\n integers, meaning the month days to apply the recurrence to.\n | \n
byyearday | \n If given, it must be either an integer, or an array of\n integers, meaning the year days to apply the recurrence to.\n | \n
byweekno | \n If given, it must be either an integer, or an array of\n integers, meaning the week numbers to apply the recurrence to.\n Week numbers have the meaning described in ISO8601, that is,\n the first week of the year is that containing at least four\n days of the new year.\n | \n
byweekday | \n If given, it must be either an integer (0 == RRule.MO), an\n array of integers, one of the weekday constants\n (RRule.MO,\n RRule.TU, etc), or an array of these constants. When\n given,\n these variables will define the weekdays where the recurrence\n will be applied. It's also possible to use an argument n for\n the weekday instances, which will mean the nth occurrence of\n this weekday in the period. For example, with\n RRule.MONTHLY,\n or with RRule.YEARLY and BYMONTH, using\n RRule.FR.nth(+1) or RRule.FR.nth(-1) in byweekday\n will specify the first or last friday of the month where the\n recurrence happens.\n Notice\n that the RFC documentation, this is specified as BYDAY,\n but was renamed to avoid the ambiguity of that argument.\n | \n
byhour | \n If given, it must be either an integer, or an array of\n integers, meaning the hours to apply the recurrence to.\n | \n
byminute | \n If given, it must be either an integer, or an array of\n integers, meaning the minutes to apply the recurrence to.\n | \n
bysecond | \n If given, it must be either an integer, or an array of\n integers, meaning the seconds to apply the recurrence to.\n | \n
byeaster | \n This is an extension to the RFC specification which the Python\n implementation provides.\n Not implemented in the JavaScript version.\n | \n
rule.optionswkstart). Currently,\n rule.options.byweekday isn't equal\n to rule.origOptions.byweekday (which is an inconsistency).\n rule.origOptionsoptions argument passed to\n the constructor.cachetrue, the rruleset or rrule created instance \nwill cache its results.\nDefault is not to cache.\ndtstartDTSTART property is found in the parsed string. \nIf it is not given, and the property is not found, \ndatetime.now() will be used instead.\nunfoldtrue, lines will be unfolded following the RFC specification. \nIt defaults to false, meaning that spaces before every line will be stripped.\nforcesettrue, an rruleset instance will be returned, \neven if only a single rule is found. \nThe default is to return an rrule if possible, and \nan rruleset if necessary.\ncompatibletrue, the parser will operate in RFC-compatible mode. \nRight now it means that unfold will be turned on, and if a DTSTART is found, \nit will be considered the first recurrence instance, as documented in the RFC.\ntzidTZID \nproperty is found in the parsed string. \nIf it is not given, and the property is not found, 'UTC' will \nbe used by default.\n