Class CalendarPeriod

A defined period of time between a CalendarPeriod.start date and a CalendarPeriod.end date.

Any value with .start and .end can be coerced to a CalendarPeriod via toCalendarPeriod.

Hierarchy

CalendarPeriod
- CalendarStep

Index

Constructors

constructor

Properties

Accessors

length

Methods

Constructors

constructor

new CalendarPeriod(start: string | Date, end: string | Date): CalendarPeriod
new CalendarPeriod(start: string | Date, interval: CalendarInterval): CalendarPeriod
new CalendarPeriod(start: string | Date, interval: CalendarUnit, n?: Integer): CalendarPeriod

- Defined in src/calendar/calendar-period.ts:33
Parameters
- start: string | Date
- end: string | Date
Returns CalendarPeriod
- Defined in src/calendar/calendar-period.ts:34
Parameters
- start: string | Date
- interval: CalendarInterval
Returns CalendarPeriod
- Defined in src/calendar/calendar-period.ts:35
Parameters
- start: string | Date
- interval: CalendarUnit
- Optional n: Integer
Returns CalendarPeriod

Properties

Readonly end

end: Date

The end date of the period, exclusive.

Readonly start

start: Date

The starting date of the period.

Static calendarRange

calendarRange: (start: Date, end: Date, unit: CalendarUnit, n?: number) => ICalendarRange

Type declaration

- (start: Date, end: Date, unit: CalendarUnit, n?: number): ICalendarRange
- Parameters
  - start: Date
  - end: Date
  - unit: CalendarUnit
  - Optional n: number
  Returns ICalendarRange

Accessors

length

get length(): CalendarLength

- Defined in src/calendar/calendar-period.ts:51
Get the length of this CalendarPeriod as a CalendarLength.

Returns CalendarLength

Methods

range

range(interval: CalendarInterval): ICalendarRange
range(unit: CalendarUnit, n: number): ICalendarRange

- Defined in src/calendar/calendar-period.ts:82
Obtain an iterable CalendarRange for this period by supplying the interval for each iteration, or by unit and quantity

Parameters
- interval: CalendarInterval
Returns ICalendarRange
- Defined in src/calendar/calendar-period.ts:83
Parameters
- unit: CalendarUnit
- n: number
Returns ICalendarRange

toString

toString(): string

- Defined in src/calendar/calendar-period.ts:88
Returns string

Generated using TypeDoc