Interface CalendarOptions

Options to provide in Client.calendar() method

Hierarchy

  • CalendarOptions

Properties

concurrency? interval?

Properties

Optional concurrency

concurrency?: null | number

The number of fetches that should occur per asynchronous task. StudentVUE does not send ALL events within a school year, but rather it sends all events within a month.

Description

// { concurrency: 1 }

Fetch events of one month at a time

// { concurrency: 7 } -> this is the default

Fetch events of 7 months at a time

If you set concurrency to 8 or more, it will throw an error because it will time out

Optional interval

interval?: {
    end: number | Date;
    start: number | Date;
}

The interval between two dates in the calendar

Type declaration

  • end: number | Date

    The end interval

  • start: number | Date

    The start interval

Settings

Member Visibility

Theme

Generated using TypeDoc