Class CalendarStep

A CalendarStep is a CalendarPeriod augmented with a step number.

Hierarchy

CalendarPeriod
- CalendarStep

Index

Constructors

constructor

Properties

Accessors

length

Methods

Constructors

constructor

new CalendarStep(start: string | Date, end: string | Date, step: Integer): CalendarStep

Overrides CalendarPeriod.constructor
- Defined in src/calendar/calendar-step.ts:31
Parameters
- start: string | Date
  
  The start Date of the time period
- end: string | Date
  
  The end Date of the time period
- step: Integer
  
  The iteration counter value.
Returns CalendarStep

Properties

Readonly end

end: Date

The end date of the period, exclusive.

Readonly start

start: Date

The starting date of the period.

Readonly step

The step number in the iteration.

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

Inherited from CalendarPeriod.range
- 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
Inherited from CalendarPeriod.range
- Defined in src/calendar/calendar-period.ts:83
Parameters
- unit: CalendarUnit
- n: number
Returns ICalendarRange

toString

toString(): string

Inherited from CalendarPeriod.toString
- Defined in src/calendar/calendar-period.ts:88
Returns string

Generated using TypeDoc