Class: Recur

Constructor

new Recur(data)

Create a new instance of the Recur class.

Parameters:

Name Type Description

data

Object

An object with members of the recurrence

Properties

Name	Type	Attributes	Description
`freq`	ICAL.Recur.frequencyValues	<optional>	The frequency value
`interval`	Number	<optional>	The INTERVAL value
`wkst`	ICAL.Time.weekDay	<optional>	The week start value
`until`	ICAL.Time	<optional>	The end of the recurrence set
`count`	Number	<optional>	The number of occurrences
`bysecond`	Array.<Number>	<optional>	The seconds for the BYSECOND part
`byminute`	Array.<Number>	<optional>	The minutes for the BYMINUTE part
`byhour`	Array.<Number>	<optional>	The hours for the BYHOUR part
`byday`	Array.<String>	<optional>	The BYDAY values
`bymonthday`	Array.<Number>	<optional>	The days for the BYMONTHDAY part
`byyearday`	Array.<Number>	<optional>	The days for the BYYEARDAY part
`byweekno`	Array.<Number>	<optional>	The weeks for the BYWEEKNO part
`bymonth`	Array.<Number>	<optional>	The month for the BYMONTH part
`bysetpos`	Array.<Number>	<optional>	The positionals for the BYSETPOS part

Source: recur.js, line 46

Members

(nullable) count :Number

The maximum number of occurrences

Type:

Number

Source: recur.js, line 237

freq :ICAL.Recur.frequencyValues

The frequency value.

Type:

ICAL.Recur.frequencyValues

Source: recur.js, line 243

(constant) icalclass :String

The class identifier.

Type:

String

Default Value: "icalrecur"
Source: recur.js, line 251

(constant) icaltype :String

The type name, to be used in the jCal object.

Type:

String

Default Value: "recur"
Source: recur.js, line 259

interval :Number

The interval value for the recurrence rule.

Type:

Number

Source: recur.js, line 217

parts :ICAL.Recur.byParts

An object holding the BY-parts of the recurrence rule

Type:

ICAL.Recur.byParts

Source: recur.js, line 211

(nullable) until :ICAL.Time

The end of the recurrence

Type:

ICAL.Time

Source: recur.js, line 231

wkst :ICAL.Time.weekDay

The week start day

Type:

ICAL.Time.weekDay

Default Value: ICAL.Time.MONDAY
Source: recur.js, line 225

Methods

addComponent(aType, aValue)

Adds a component (part) to the recurrence rule. This is not a component in the sense of ICAL.Component, but a part of the recurrence rule, i.e. BYMONTH.

Parameters:

Name	Type	Description
`aType`	String	The name of the component part
`aValue`	Array \| String	The component value

Source: recur.js, line 323

clone() → {ICAL.Recur}

Returns a clone of the recurrence object.

Source: recur.js, line 292

Returns:

The cloned object

Type:: ICAL.Recur

fromData(data)

Sets up the current instance using members from the passed data object.

Parameters:

Name Type Description

data

Object

An object with members of the recurrence

Properties

Name	Type	Attributes	Description
`freq`	ICAL.Recur.frequencyValues	<optional>	The frequency value
`interval`	Number	<optional>	The INTERVAL value
`wkst`	ICAL.Time.weekDay	<optional>	The week start value
`until`	ICAL.Time	<optional>	The end of the recurrence set
`count`	Number	<optional>	The number of occurrences
`bysecond`	Array.<Number>	<optional>	The seconds for the BYSECOND part
`byminute`	Array.<Number>	<optional>	The minutes for the BYMINUTE part
`byhour`	Array.<Number>	<optional>	The hours for the BYHOUR part
`byday`	Array.<String>	<optional>	The BYDAY values
`bymonthday`	Array.<Number>	<optional>	The days for the BYMONTHDAY part
`byyearday`	Array.<Number>	<optional>	The days for the BYYEARDAY part
`byweekno`	Array.<Number>	<optional>	The weeks for the BYWEEKNO part
`bymonth`	Array.<Number>	<optional>	The month for the BYMONTH part
`bysetpos`	Array.<Number>	<optional>	The positionals for the BYSETPOS part

Source: recur.js, line 401

getComponent(aType) → {Array}

Gets (a copy) of the requested component value.

Parameters:

Name	Type	Description
`aType`	String	The component part name

Source: recur.js, line 348

Returns:

The component part value

Type:: Array

getNextOccurrence(aStartTime, aRecurrenceId) → {ICAL.Time}

Retrieves the next occurrence after the given recurrence id. See the guide on terminology for more details.

NOTE: Currently, this method iterates all occurrences from the start date. It should not be called in a loop for performance reasons. If you would like to get more than one occurrence, you can iterate the occurrences manually, see the example on the iterator method.

Parameters:

Name	Type	Description
`aStartTime`	ICAL.Time	The start of the event series
`aRecurrenceId`	ICAL.Time	The date of the last occurrence

Source: recur.js, line 367

Returns:

The next occurrence after

Type:: ICAL.Time

isByCount() → {Boolean}

Checks if the current rule has a count part, and not limited by an until part.

Source: recur.js, line 311

Returns:

True, if the rule is by count

Type:: Boolean

isFinite() → {Boolean}

Checks if the current rule is finite, i.e. has a count or until part.

Source: recur.js, line 301

Returns:

True, if the rule is finite

Type:: Boolean

iterator(aStart) → {ICAL.RecurIterator}

Create a new iterator for this recurrence rule. The passed start date must be the start date of the event, not the start of the range to search in.

Parameters:

Name	Type	Description
`aStart`	ICAL.Time	The item's start date

Source: recur.js, line 280

Returns:

The recurrence iterator

Type:: ICAL.RecurIterator

Example

let recur = comp.getFirstPropertyValue('rrule');
let dtstart = comp.getFirstPropertyValue('dtstart');
let iter = recur.iterator(dtstart);
for (let next = iter.next(); next; next = iter.next()) {
  if (next.compare(rangeStart) < 0) {
    continue;
  }
  console.log(next.toString());
}

setComponent(aType, aValues)

Sets the component value for the given by-part.

Parameters:

Name	Type	Description
`aType`	String	The component part name
`aValues`	Array	The component values

Source: recur.js, line 338

toJSON() → {Object}

The jCal representation of this recurrence type.

Source: recur.js, line 433

Returns:

Type:: Object

toString() → {String}

The string representation of this recurrence rule.

Source: recur.js, line 466

Returns:

Type:: String

(static) fromData(aData)

Creates a new ICAL.Recur instance using members from the passed data object.

Parameters:

Name Type Description

aData

Object

An object with members of the recurrence

Properties

Name	Type	Attributes	Description
`freq`	ICAL.Recur.frequencyValues	<optional>	The frequency value
`interval`	Number	<optional>	The INTERVAL value
`wkst`	ICAL.Time.weekDay	<optional>	The week start value
`until`	ICAL.Time	<optional>	The end of the recurrence set
`count`	Number	<optional>	The number of occurrences
`bysecond`	Array.<Number>	<optional>	The seconds for the BYSECOND part
`byminute`	Array.<Number>	<optional>	The minutes for the BYMINUTE part
`byhour`	Array.<Number>	<optional>	The hours for the BYHOUR part
`byday`	Array.<String>	<optional>	The BYDAY values
`bymonthday`	Array.<Number>	<optional>	The days for the BYMONTHDAY part
`byyearday`	Array.<Number>	<optional>	The days for the BYYEARDAY part
`byweekno`	Array.<Number>	<optional>	The weeks for the BYWEEKNO part
`bymonth`	Array.<Number>	<optional>	The month for the BYMONTH part
`bysetpos`	Array.<Number>	<optional>	The positionals for the BYSETPOS part

Source: recur.js, line 78

(static) fromString(string) → {ICAL.Recur}

Creates a new ICAL.Recur instance from the passed string.

Parameters:

Name	Type	Description
`string`	String	The string to parse

Source: recur.js, line 53

Returns:

The created recurrence instance

Type:: ICAL.Recur

(static) icalDayToNumericDay(string, aWeekStartopt) → {Number}

Convert an ical representation of a day (SU, MO, etc..) into a numeric value of that day.

Parameters:

Name	Type	Attributes	Description
`string`	String		The iCalendar day name
`aWeekStart`	ICAL.Time.weekDay	<optional>	The week start weekday, defaults to SUNDAY

Source: recur.js, line 137

Returns:

Numeric value of given day

Type:: Number

(static) numericDayToIcalDay(num, aWeekStartopt) → {String}

Convert a numeric day value into its ical representation (SU, MO, etc..)

Parameters:

Name	Type	Attributes	Description
`num`	Number		Numeric value of given day
`aWeekStart`	ICAL.Time.weekDay	<optional>	The week start weekday, defaults to SUNDAY

Source: recur.js, line 152

Returns:

The ICAL day value, e.g SU,MO,...

Type:: String

Type Definitions

byParts

An object holding the BY-parts of the recurrence rule

Type:

Object

Properties

Name	Type	Attributes	Description
`BYSECOND`	Array.<Number>	<optional>	The seconds for the BYSECOND part
`BYMINUTE`	Array.<Number>	<optional>	The minutes for the BYMINUTE part
`BYHOUR`	Array.<Number>	<optional>	The hours for the BYHOUR part
`BYDAY`	Array.<String>	<optional>	The BYDAY values
`BYMONTHDAY`	Array.<Number>	<optional>	The days for the BYMONTHDAY part
`BYYEARDAY`	Array.<Number>	<optional>	The days for the BYYEARDAY part
`BYWEEKNO`	Array.<Number>	<optional>	The weeks for the BYWEEKNO part
`BYMONTH`	Array.<Number>	<optional>	The month for the BYMONTH part
`BYSETPOS`	Array.<Number>	<optional>	The positionals for the BYSETPOS part

Source: recur.js, line 192

frequencyValues

Possible frequency values for the FREQ part (YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY, SECONDLY)

Type:

String

Source: types.js, line 24