Class Duration

constructor

• new Duration(data?): Duration

• Creates a new ICAL.Duration instance.

  Parameters

  • Optional data: DurationData

    An object with members of the duration

  Returns Duration

days

hours

Readonly icalclass

icaltype

isNegative

minutes

seconds

weeks

wrappedJSObject

clone

• clone(): Duration

• Returns a clone of the duration object.

  Returns Duration

  The cloned object

compare

• compare(aOther): number

• Compares the duration instance with another one.

  Parameters

  • aOther: Duration

    The instance to compare with

  Returns number

  -1, 0 or 1 for less/equal/greater

fromData

• fromData(aData?): void

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

  Parameters

  • Optional aData: DurationData

    An object with members of the duration

  Returns void

fromSeconds

• fromSeconds(aSeconds): Duration

• Reads the passed seconds value into this duration object. Afterwards, members like days and weeks will be set up accordingly.

  Parameters

  • aSeconds: number

    The duration value in seconds

  Returns Duration

  Returns this instance

normalize

• normalize(): void

• Normalizes the duration instance. For example, a duration with a value of 61 seconds will be normalized to 1 minute and 1 second.

  Returns void

reset

• reset(): void

• Resets the duration instance to the default values, i.e. PT0S

  Returns void

toICALString

• toICALString(): string

• The iCalendar string representation of this duration.

  Returns string

toSeconds

• toSeconds(): number

• The duration value expressed as a number of seconds.

  Returns number

  The duration value in seconds

toString

• toString(): string

• The string representation of this duration.

  Returns string

Static fromData

• fromData(aData): Duration

• Creates a new ICAL.Duration instance from the given data object.

  Parameters

  • aData: DurationData

    An object with members of the duration

  Returns Duration

  The created duration instance

Static fromSeconds

• fromSeconds(aSeconds): Duration

• Returns a new ICAL.Duration instance from the passed seconds value.

  Parameters

  • aSeconds: number

    The seconds to create the instance from

  Returns Duration

  The newly created duration instance

Static fromString

• fromString(aStr): Duration

• Creates a new Duration instance from the passed string.

  Parameters

  • aStr: string

    The string to parse

  Returns Duration

  The created duration instance

Static isValueString

• isValueString(string): boolean

• Checks if the given string is an iCalendar duration value.

  Parameters

  • string: string

    The raw ical value

  Returns boolean

  True, if the given value is of the duration ical type