@js-joda/extra/typings/js-joda-extra.d.ts

additional date-time classes that complement those in js-joda

import { Instant, Duration, TemporalAccessor, Clock, ZoneId, TemporalField, ValueRange, TemporalQuery, Temporal, LocalDate, Year, MonthDay, YearMonth, Month, DateTimeFormatter, DayOfWeek, TemporalUnit, TemporalAmount, TemporalAdjuster, ZoneOffset, OffsetDateTime, LocalTime, Period } from '@js-joda/core';

export class DayOfMonth extends TemporalAccessor {
    static from(temporal: TemporalAccessor): DayOfMonth;
    static now(zoneIdOrClock?: ZoneId | Clock): DayOfMonth;
    static of(dayOfMonth: number): DayOfMonth;

    private constructor(dayOfMonth: number);

    adjustInto(temporal: Temporal): Temporal;
    atMonth(month: number | Month): MonthDay;
    atYearMonth(yearMonth: YearMonth): LocalDate;
    compareTo(other: DayOfMonth): number;
    equals(obj: any): boolean;
    get(field: TemporalField): number;
    getLong(field: TemporalField): number;
    value(): number;
    hashCode(): number;
    isSupported(field: TemporalField): boolean;
    isValidYearMonth(yearMonth: YearMonth): boolean;
    query<R>(query: TemporalQuery<R>): R | null;
    range(field: TemporalField): ValueRange;
    toString(): string;
}

export class DayOfYear extends TemporalAccessor {
    static from(temporal: TemporalAccessor): DayOfYear;
    static now(zoneIdOrClock?: ZoneId | Clock): DayOfYear;
    static of(dayOfYear: number): DayOfYear;

    private constructor(dayOfYear: number);

    adjustInto(temporal: Temporal): Temporal;
    atYear(year: number | Year): LocalDate;
    compareTo(other: DayOfYear): number;
    equals(obj: any): boolean;
    get(field: TemporalField): number;
    getLong(field: TemporalField): number;
    value(): number;
    hashCode(): number;
    isSupported(field: TemporalField): boolean;
    isValidYear(year: number): boolean;
    query<R>(query: TemporalQuery<R>): R | null;
    range(field: TemporalField): ValueRange;
    toString(): string;
}

export class Interval {
    static of(startInclusive: Instant, endExclusiveInstantOrDuration: Instant | Duration): Interval;
    static parse(text: string): Interval;

    private constructor(startInclusive: Instant, endExclusive: Instant);

    start(): Instant;
    end(): Instant;
    isEmpty(): boolean;
    isUnboundedStart(): boolean;
    isUnboundedEnd(): boolean;
    withStart(start: Instant): Interval;
    withEnd(end: Instant): Interval;
    contains(instant: Instant): boolean;
    encloses(other: Interval): boolean;
    abuts(other: Interval): boolean;
    isConnected(other: Interval): boolean;
    overlaps(other: Interval): boolean;
    intersection(other: Interval): Interval;
    union(other: Interval): Interval;
    span(other: Interval): Interval;
    isAfter(instantOrInterval: Instant | Interval): boolean;
    isBefore(instantOrInterval: Instant | Interval): boolean;
    isAfterInstant(instant: Instant): boolean;
    isBeforeInstant(instant: Instant): boolean;
    isAfterInterval(interval: Interval): boolean;
    isBeforeInterval(interval: Interval): boolean;
    toDuration(): Duration;
    equals(other: any): boolean;
    hashCode(): number;
    toString(): string;
}

export class LocalDateRange {
    static of(startInclusive: LocalDate, endExclusive: LocalDate): LocalDateRange;
    static of(startInclusive: LocalDate, period: Period): LocalDateRange;
    static ofClosed(startInclusive: LocalDate, endInclusive: LocalDate): LocalDateRange;
    static ofEmpty(date: LocalDate): LocalDateRange;
    static ofUnbounded(): LocalDateRange;
    static ofUnboundedEnd(startInclusive: LocalDate): LocalDateRange;
    static ofUnboundedStart(endExclusive: LocalDate): LocalDateRange;
    static parse(text: string): LocalDateRange;

    private constructor(startInclusive: LocalDate, endExclusive: LocalDate);

    abuts(other: LocalDateRange): boolean;
    contains(date: LocalDate): boolean;
    encloses(other: LocalDateRange): boolean;
    equals(obj: any): boolean;
    end(): LocalDate;
    endInclusive(): LocalDate;
    start(): LocalDate;
    hashCode(): number;
    intersection(other: LocalDateRange): LocalDateRange;
    isAfter(rangeOrDate: LocalDate | LocalDateRange): boolean;
    isBefore(rangeOrDate: LocalDate | LocalDateRange): boolean;
    isConnected(other: LocalDateRange): boolean;
    isEmpty(): boolean;
    isUnboundedEnd(): boolean;
    isUnboundedStart(): boolean;
    lengthInDays(): number;
    overlaps(other: LocalDateRange): boolean;
    span(other: LocalDateRange): LocalDateRange;
    toPeriod(): Period;
    toString(): string;
    union(other: LocalDateRange): LocalDateRange;
    withEnd(adjuster: TemporalAdjuster): LocalDateRange;
    withStart(adjuster: TemporalAdjuster): LocalDateRange;
}

export class OffsetDate extends Temporal implements TemporalAdjuster {
    static from(temporal: TemporalAccessor): OffsetDate;
    static now(zoneIdOrClock?: ZoneId | Clock): OffsetDate;
    static of(year: number, month: number, dayOfMonth: number, offset: ZoneOffset): OffsetDate;
    static of(date: LocalDate, offset: ZoneOffset): OffsetDate;
    static ofInstant(instant: Instant, zone: ZoneId): OffsetDate;
    static parse(text: string, formatter?: DateTimeFormatter): OffsetDate;

    private constructor(date: LocalDate, offset: ZoneOffset);

    adjustInto(temporal: Temporal): Temporal;
    atTime(time: LocalTime): OffsetDateTime;
    compareTo(other: OffsetDate): number;
    equals(object: any): boolean
    format(formatter: DateTimeFormatter): string;
    get(field: TemporalField): number;
    dayOfMonth(): number;
    dayOfWeek(): number;
    dayOfYear(): number;
    getLong(field: TemporalField): number;
    month(): Month;
    monthValue(): number;
    offset(): ZoneOffset;
    year(): number;
    hashCode(): number;
    isAfter(other: OffsetDate): boolean;
    isBefore(other: OffsetDate): boolean;
    isEqual(other: OffsetDate): boolean;
    isSupported(fieldOrUnit: TemporalField | TemporalUnit): boolean;
    minus(amountToSubtract: number, unit: TemporalUnit): OffsetDate;
    minus(amountToSubtract: TemporalAmount): OffsetDate;
    minusDays(days: number): OffsetDate;
    minusMonths(months: number): OffsetDate;
    minusWeeks(weeks: number): OffsetDate;
    minusYears(years: number): OffsetDate;
    plus(amountToAdd: number, unit: TemporalUnit): OffsetDate;
    plus(amountToAdd: TemporalAmount): OffsetDate;
    plusDays(days: number): OffsetDate;
    plusMonths(months: number): OffsetDate;
    plusWeeks(weeks: number): OffsetDate;
    plusYears(years: number): OffsetDate;
    query<R>(query: TemporalQuery<R>): R | null;
    range(field: TemporalField): ValueRange;
    toEpochSecond(time: LocalTime): number;
    toLocalDate(): LocalDate;
    toString(): string;
    until(endExclusive: Temporal, unit: TemporalUnit): number;
    with(adjuster: TemporalAdjuster): OffsetDate;
    with(field: TemporalField, newValue: number): OffsetDate;
    withDayOfMonth(dayOfMonth: number): OffsetDate;
    withDayOfYear(dayOfYear: number): OffsetDate;
    withMonth(month: number): OffsetDate;
    withOffsetSameLocal(offset: ZoneOffset): OffsetDate;
    withYear(year: number): OffsetDate;

    protected _minusUnit(amountToSubtract: number, unit: TemporalUnit): OffsetDate;
    protected _minusAmount(amount: TemporalAmount): OffsetDate;
    protected _plusUnit(amountToAdd: number, unit: TemporalUnit): OffsetDate;
    protected _plusAmount(amount: TemporalAmount): OffsetDate;
    protected _withAdjuster(adjuster: TemporalAdjuster): OffsetDate;
    protected _withField(field: TemporalField, newValue: number): OffsetDate;
}

export class Quarter extends TemporalAccessor implements TemporalAdjuster {
    static Q1: Quarter;
    static Q2: Quarter;
    static Q3: Quarter;
    static Q4: Quarter;

    static from(temporal: TemporalAccessor): Quarter;
    static of(quarterOfYear: number): Quarter;
    static ofMonth(monthOfYear: number): Quarter;
    static valueOf(name: string): Quarter;
    static values(): Quarter[];

    private constructor(value: number, name: string);

    adjustInto(temporal: Temporal): Temporal;
    compareTo(other: Quarter): number;
    equals(other: any): boolean;
    firstMonth(): Month;
    get(field: TemporalField): number;
    getLong(field: TemporalField): number;
    isSupported(field: TemporalField): boolean;
    length(leapYear: boolean): number;
    minus(months: number): Quarter;
    name(): string;
    ordinal(): number;
    plus(months: number): Quarter;
    query<R>(query: TemporalQuery<R>): R | null;
    range(field: TemporalField): ValueRange;
    toString(): string;
    value(): number;
}

export class Temporals {
    static nextWorkingDay(): TemporalAdjuster;
    static nextWorkingDayOrSame(): TemporalAdjuster;
    static previousWorkingDay(): TemporalAdjuster;
    static previousWorkingDayOrSame(): TemporalAdjuster;
    static parseFirstMatching<T>(text: string, query: TemporalQuery<T>, ...formatters: DateTimeFormatter[]): T;
    static convertAmount(amount: number, fromUnit: TemporalUnit, toUnit: TemporalUnit): number[];

    private constructor();
}

export class YearQuarter extends Temporal {
    static from(temporal: TemporalAccessor): YearQuarter;
    static now(zoneIdOrClock?: ZoneId | Clock): YearQuarter;
    static of(year: Year | number, quarter: Quarter | number): YearQuarter;
    static parse(text: string, formatter?: DateTimeFormatter): YearQuarter;

    private constructor(year: number, quarter: Quarter);

    isSupported(fieldOrUnit: TemporalField | TemporalUnit): boolean
    range(field: TemporalField): ValueRange;
    get(field: TemporalField): number;
    getLong(field: TemporalField): number;
    year(): number;
    quarterValue(): number;
    quarter(): Quarter;
    isLeapYear(): boolean;
    isValidDay(dayOfQuarter: number): boolean;
    lengthOfQuarter(): number;
    lengthOfYear(): number;
    with(adjuster: TemporalAdjuster): YearQuarter;
    with(field: TemporalField, newValue: number): YearQuarter;
    withYear(year: number): YearQuarter;
    withQuarter(quarter: number): YearQuarter;
    plus(amountToAdd: number, unit: TemporalUnit): YearQuarter;
    plus(amountToAdd: TemporalAmount): YearQuarter;
    plusYears(yearsToAdd: number): YearQuarter
    plusQuarters(quartersToAdd: number): YearQuarter
    minus(amountToSubtract: number, unit: TemporalUnit): YearQuarter;
    minus(amountToSubtract: TemporalAmount): YearQuarter;
    minusYears(yearsToSubtract: number): YearQuarter
    minusQuarters(quartersToSubtract: number): YearQuarter
    query<R>(query: TemporalQuery<R>): R | null;
    adjustInto(temporal: Temporal): Temporal;
    until(endExclusive: Temporal, unit: TemporalUnit): number;
    format(formatter: DateTimeFormatter): string;
    atDay(dayOfQuarter: number): LocalDate
    atEndOfQuarter(): YearQuarter;
    compareTo(other: YearQuarter): number;
    isAfter(other: YearQuarter): boolean
    isBefore(other: YearQuarter): boolean
    equals(obj: any): boolean;
    hashCode(): number;
    toString(): string;

    protected _minusUnit(amountToSubtract: number, unit: TemporalUnit): YearQuarter;
    protected _minusAmount(amount: TemporalAmount): YearQuarter;
    protected _plusUnit(amountToAdd: number, unit: TemporalUnit): YearQuarter;
    protected _plusAmount(amount: TemporalAmount): YearQuarter;
    protected _withAdjuster(adjuster: TemporalAdjuster): YearQuarter;
    protected _withField(field: TemporalField, newValue: number): YearQuarter;
}

export class YearWeek extends Temporal {
    static from(temporal: TemporalAccessor): YearWeek;
    static now(zoneIdOrClock?: ZoneId | Clock): YearWeek;
    static of(year: Year | number, week: number): YearWeek;
    static parse(text: string, formatter?: DateTimeFormatter): YearWeek;

    private constructor(weekBasedYear: number, week: number);

    adjustInto(temporal: Temporal): Temporal;
    atDay(dayOfWeek: DayOfWeek): LocalDate;
    compareTo(other: YearWeek): number;
    equals(obj: any): boolean;
    format(formatter: DateTimeFormatter): string;
    get(field: TemporalField): number;
    getLong(field: TemporalField): number;
    week(): number;
    year(): number;
    hashCode(): number;
    is53WeekYear(): boolean
    isAfter(other: YearWeek): boolean
    isBefore(other: YearWeek): boolean
    isSupported(fieldOrUnit: TemporalField | TemporalUnit): boolean;
    lengthOfYear(): number;
    minus(amountToSubtract: number, unit: TemporalUnit): YearWeek;
    minus(amountToSubtract: TemporalAmount): YearWeek;
    minusWeeks(weeksToSubtract: number): YearWeek;
    minusYears(yearsToSubtract: number): YearWeek;
    plus(amountToAdd: number, unit: TemporalUnit): YearWeek;
    plus(amountToAdd: TemporalAmount): YearWeek;
    plusWeeks(weeksToAdd: number): YearWeek;
    plusYears(yearsToAdd: number): YearWeek;
    query<R>(query: TemporalQuery<R>): R | null;
    range(field: TemporalField): ValueRange;
    toString(): string;
    until(endExclusive: Temporal, unit: TemporalUnit): number;
    with(adjuster: TemporalAdjuster): YearWeek;
    with(field: TemporalField, newValue: number): YearWeek;
    withWeek(week: number): YearWeek;
    withYear(weekBasedYear: number): YearWeek;

    protected _minusUnit(amountToSubtract: number, unit: TemporalUnit): YearWeek;
    protected _minusAmount(amount: TemporalAmount): YearWeek;
    protected _plusUnit(amountToAdd: number, unit: TemporalUnit): YearWeek;
    protected _plusAmount(amount: TemporalAmount): YearWeek;
    protected _withAdjuster(adjuster: TemporalAdjuster): YearWeek;
    protected _withField(field: TemporalField, newValue: number): YearWeek;
}

export const __esModule: true;
export as namespace JSJodaExtra;