DefinitelyTyped/types/moment-range/index.d.ts

// Type definitions for Moment-range.js 3.1
// Project: https://github.com/rotaready/moment-range
// Definitions by: Bart van den Burg <https://github.com/Burgov>
//                 Wilgert Velinga <https://github.com/wilgert>
//                 Juan Francisco Adame <https://github.com/franjuan>
//                 MartynasZilinskas <https://github.com/MartynasZilinskas>
//                 Che Coxshall <https://github.com/chemass>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

import moment = require('moment');

export class DateRange {
    start: moment.Moment;
    end: moment.Moment;

    constructor(range: string | Date[] | moment.Moment[]);
    constructor(start: Date | moment.Moment, end: Date | moment.Moment);

    contains(other: DateRange | moment.Moment | Date, options?: { exclusive?: boolean }): boolean;

    overlaps(range: DateRange, options?: { adjacent?: boolean }): boolean;

    intersect(other: DateRange): DateRange;

    add(other: DateRange, options?: { adjacent?: boolean }): DateRange;

    subtract(other: DateRange): DateRange[];

    by(interval: moment.unitOfTime.Diff, options?: { exclusive?: boolean, step?: number }): Iterable<moment.Moment>;

    byRange(interval: DateRange, options?: { exclusive?: boolean, step?: number }): Iterable<moment.Moment>;

    isSame(other: DateRange): boolean;

    diff(unit?: moment.unitOfTime.Diff, rounded?: boolean): number;

    toDate(): Date[];

    toString(): string;

    valueOf(): number;

    center(): moment.Moment;

    clone(): DateRange;

    isEqual(other: DateRange): boolean;

    adjacent(other: DateRange): boolean;

    duration(unit?: moment.unitOfTime.Diff, precise?: boolean): number;

    reverseBy(interval: moment.unitOfTime.Diff, options?: { exclusive?: boolean, step?: number }): Iterable<moment.Moment>;

    reverseByRange(interval: DateRange, options?: { exclusive?: boolean, step?: number }): Iterable<moment.Moment>;
}

export interface MomentRangeMethods {
    range(range: string | Date[] | moment.Moment[]): DateRange;
    range(start: Date | moment.Moment, end: Date | moment.Moment): DateRange;
    isRange(range: any): range is DateRange;
    within(range: DateRange): boolean;
}

export interface MomentRangeExtends extends MomentRangeMethods {
    (...args: any[]): MomentRangeMethods & moment.Moment;
}

export function extendMoment(momentInstance: moment.Moment | typeof moment): MomentRangeExtends & moment.Moment;