Circle V2 API Docs
    Preparing search index...
    • VERBATIM port of v1 getMatchingScheduleEntry: the entry for today (in the schedule's timezone) whose hour has already passed, preferring the one closest to the current hour.

      Parameters

      • schedule: {
            schedule: {
                day:
                    | "sunday"
                    | "monday"
                    | "tuesday"
                    | "wednesday"
                    | "thursday"
                    | "friday"
                    | "saturday";
                hour: number;
                minute: 0;
            }[];
            timezone: string;
        }
      • refTime: Date = ...

      Returns
          | {
              day: | "sunday"
              | "monday"
              | "tuesday"
              | "wednesday"
              | "thursday"
              | "friday"
              | "saturday";
              hour: number;
              minute: 0;
          }
          | null