Class Recur

constructor

• new Recur(data): Recur

• Create a new instance of the Recur class.

  Parameters

  • data: RecurData

    An object with members of the recurrence

  Returns Recur

Optional count

Optional freq

Readonly icalclass

Readonly icaltype

interval

parts

Optional until

wkst

wrappedJSObject

addComponent

• addComponent(aType, aValue): void

• 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

  • aType: string

    The name of the component part

  • aValue: string | any[]

    The component value

  Returns void

clone

• clone(): Recur

• Returns a clone of the recurrence object.

  Returns Recur

  The cloned object

fromData

• fromData(data): void

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

  Parameters

  • data: RecurData

    An object with members of the recurrence

  Returns void

getComponent

• getComponent(aType): any[]

• Gets (a copy) of the requested component value.

  Parameters

  • aType: string

    The component part name

  Returns any[]

  The component part value

getNextOccurrence

• getNextOccurrence(aStartTime, aRecurrenceId): Time

• Retrieves the next occurrence after the given recurrence id. See the guide on {@tutorial 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 ICAL.Recur#iterator iterator method.

  Parameters

  • aStartTime: Time

    The start of the event series

  • aRecurrenceId: Time

    The date of the last occurrence

  Returns Time

  The next occurrence after

isByCount

• isByCount(): boolean

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

  Returns boolean

  True, if the rule is by count

isFinite

• isFinite(): boolean

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

  Returns boolean

  True, if the rule is finite

iterator

• iterator(aStart): 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

  • aStart: Time

    The item's start date

  Returns RecurIterator

  The recurrence iterator

  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());
  }
  Copy

setComponent

• setComponent(aType, aValues): void

• Sets the component value for the given by-part.

  Parameters

  • aType: string

    The component part name

  • aValues: any[]

    The component values

  Returns void

toJSON

• toJSON(): object

• The jCal representation of this recurrence type.

  Returns object

toString

• toString(): string

• The string representation of this recurrence rule.

  Returns string

Static fromData

• fromData(aData): Recur

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

  Parameters

  • aData: RecurData

    An object with members of the recurrence

  Returns Recur

Static fromString

• fromString(string): Recur

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

  Parameters

  • string: string

    The string to parse

  Returns Recur

  The created recurrence instance

Static icalDayToNumericDay

• icalDayToNumericDay(string, aWeekStart?): number

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

  Parameters

  • string: string

    The iCalendar day name

  • Optional aWeekStart: WeekDay

    The week start weekday, defaults to SUNDAY

  Returns number

  Numeric value of given day

Static numericDayToIcalDay

• numericDayToIcalDay(num, aWeekStart?): string

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

  Parameters

  • num: number

    Numeric value of given day

  • Optional aWeekStart: WeekDay

    The week start weekday, defaults to SUNDAY

  Returns string

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