import { Component } from '../component'; import { CalendarDateOrTime } from '../date'; export declare const knownOffsetTypes: string[]; export type OffsetType = (typeof knownOffsetTypes)[number]; type Digit = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'; export type Offset = `${'-' | '+'}${Digit}${Digit}${Digit}${Digit}`; /** * Represents a STANDARD or DAYLIGHT subcomponent, defining a time zone offset. */ export declare class TimeZoneOffset extends Component { /** * @param type If this is a STANDARD or DAYLIGHT component. * @param start From when this offset is active. * @param offsetFrom The offset that is in use prior to this time zone observance. * @param offsetTo The offset that is in use during this time zone observance. */ constructor(type: OffsetType, start: CalendarDateOrTime | Date, offsetFrom: Offset, offsetTo: Offset); constructor(component: Component); validate(): void; /** * Get the date or time when this time zone offset starts. * @returns The start date or time of this time zone offset. */ getStart(): CalendarDateOrTime; /** * Set the date or time when this time zone offset starts. * @param value The start date or time. * @returns The TimeZoneOffset instance for chaining. */ setStart(value: CalendarDateOrTime | Date): this; /** * Get the offset which is offset from during this time zone offset. * @returns The offset in a format such as "+0100" or "-0230". */ getOffsetFrom(): Offset; /** * Set the offset to offset from during this time zone offset. * @param value An offset such as "+0100" or "-0230". * @returns The TimeZoneOffset instance for chaining. */ setOffsetFrom(value: Offset): this; /** * Get the offset which is offset to during this time zone offset. * @returns The offset in a format such as "+0100" or "-0230". */ getOffsetTo(): Offset; /** * Set the offset to offset to during this time zone offset. * @param value An offset such as "+0100" or "-0230". * @returns The TimeZoneOffset instance for chaining. */ setOffsetTo(value: Offset): this; getComment(): string | undefined; setComment(value: string): this; removeComment(): void; /** * Get the name of this time zone offset. * @returns The time zone offset name if it exists. */ getTimeZoneName(): string | undefined; /** * Set the name of this time zone offset. * @param value The new name. * @returns The TimeZoneOffset instance for chaining. * @example * timeZoneOffset.setTimeZoneName('EST') */ setTimeZoneName(value: string): this; /** * Remove the name of this time zone offset. */ removeTimeZoneName(): void; } export {}; //# sourceMappingURL=TimeZoneOffset.d.ts.map