Class UtcOffset

constructor

• new UtcOffset(aData?): UtcOffset

• Creates a new ICAL.UtcOffset instance.

  Parameters

  • Optional aData: UtcOffsetData

    An object with members of the utc offset

  Returns UtcOffset

factor

hours

Readonly icaltype

minutes

_normalize

• _normalize(): void

• Returns void

clone

• clone(): UtcOffset

• Returns a clone of the utc offset object.

  Returns UtcOffset

  The cloned object

compare

• compare(other): number

• Compare this utc offset with another one.

  Parameters

  • other: UtcOffset

    The other offset 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: UtcOffsetData

    An object with members of the utc offset

  Returns void

fromSeconds

• fromSeconds(aSeconds): UtcOffset

• Sets up the current instance from the given seconds value. The seconds value is truncated to the minute. Offsets are wrapped when the world ends, the hour after UTC+14:00 is UTC-12:00.

  Parameters

  • aSeconds: number

    The seconds to convert into an offset

  Returns UtcOffset

toICALString

• toICALString(): string

• The iCalendar string representation of this utc-offset.

  Returns string

toSeconds

• toSeconds(): number

• Convert the current offset to a value in seconds

  Returns number

  The offset in seconds

toString

• toString(): string

• The string representation of this utc-offset.

  Returns string

Static fromSeconds

• fromSeconds(aSeconds): UtcOffset

• Creates a new ICAL.UtcOffset instance from the passed seconds value.

  Parameters

  • aSeconds: number

    The number of seconds to convert

  Returns UtcOffset

Static fromString

• fromString(aString): UtcOffset

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

  Parameters

  • aString: string

    The string to parse

  Returns UtcOffset

  The created utc-offset instance