Class Period

constructor

• new Period(aData): Period

• Creates a new ICAL.Period instance. The passed data object cannot contain both and end date and a duration.

  Parameters

  • aData: PeriodData

    An object with members of the period

  Returns Period

Optional duration

Optional end

Readonly icalclass

Readonly icaltype

Optional start

wrappedJSObject

clone

• clone(): Period

• Returns a clone of the duration object.

  Returns Period

  The cloned object

getDuration

• getDuration(): Duration

• Calculates the duration of the period, either directly or by subtracting start from end date.

  Returns Duration

  The calculated duration

getEnd

• getEnd(): Time

• Calculates the end date of the period, either directly or by adding duration to start date.

  Returns Time

  The calculated end date

toICALString

• toICALString(): string

• The iCalendar string representation of this period.

  Returns string

toJSON

• toJSON(): [string, string]

• The jCal representation of this period type.

  Returns [string, string]

toString

• toString(): string

• The string representation of this period.

  Returns string

Static fromData

• fromData(aData): Period

• Creates a new Period instance from the given data object. The passed data object cannot contain both and end date and a duration.

  Parameters

  • aData: PeriodData

    An object with members of the period

  Returns Period

  The period instance

Static fromJSON

• fromJSON(aData, aProp, aLenient): Period

• Returns a new period instance from the given jCal data array. The first member is always the start date string, the second member is either a duration or end date string.

  Parameters

  • aData: string | [string, string]

    The jCal data array

  • aProp: undefined | Property

    The property this jCal data is on

  • aLenient: boolean

    If true, data value can be both date and date-time

  Returns Period

  The period instance

Static fromString

• fromString(str, prop): Period

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

  Parameters

  • str: string

    The string to parse

  • prop: Property

    The property this period will be on

  Returns Period

  The created period instance