Module calendar/calendar-range

calendarRange

• calendarRange(start: Date | string, end: Date | string, unit: CalendarUnit, n?: Relaxed<Integer>): CalendarRange
• calendarRange(start: Date | string, end: Date | string, interval: Relaxed<CalendarInterval, TagOf<Integer>>): CalendarRange

• Construct a CalendarRange.

  A CalendarRange is a CalendarPeriod that is divided up by increments of time into a series of CalendarStep segments. These segments can be iterated over in a for loop:

  for (const step in calendarRange) {
       console.log(step.start, step.end, JSON.stringify(step.length));
  }
  

  Parameters

  • start: Date | string

    The start Date.

  • end: Date | string

    The end Date.

  • unit: CalendarUnit

    The units of increment.

  • Optional n: Relaxed<Integer>

    The number of units.

  Returns CalendarRange

• Parameters

  • start: Date | string

  • end: Date | string

  • interval: Relaxed<CalendarInterval, TagOf<Integer>>

  Returns CalendarRange