Skip to content

dependabit / monitor/src / Scheduler

Class: Scheduler

Defined in: packages/monitor/src/scheduler.ts:21

Scheduler for per-dependency monitoring

Determines which dependencies should be checked based on:

  • Check frequency (hourly, daily, weekly, monthly)
  • Last checked timestamp
  • Enabled/disabled status
  • IgnoreChanges flag
  • Config overrides

Constructors

Constructor

ts
new Scheduler(): Scheduler;

Returns

Scheduler

Methods

filterDependenciesToCheck()

ts
filterDependenciesToCheck(
   dependencies, 
   config, 
   currentTime?): DependencyEntry[];

Defined in: packages/monitor/src/scheduler.ts:80

Filter dependencies that should be checked

Parameters

ParameterTypeDescription
dependenciesDependencyEntry[]Array of dependencies
configDependabitConfigConfiguration
currentTimeDateCurrent time (defaults to now)

Returns

DependencyEntry[]

Filtered array of dependencies to check


getNextCheckTime()

ts
getNextCheckTime(dependency, config): Date;

Defined in: packages/monitor/src/scheduler.ts:116

Get next check time for a dependency

Parameters

ParameterTypeDescription
dependencyDependencyEntryDependency entry
configDependabitConfigConfiguration

Returns

Date

Next check time


getScheduleSummary()

ts
getScheduleSummary(dependencies, config): {
  daily: number;
  disabled: number;
  hourly: number;
  monthly: number;
  weekly: number;
};

Defined in: packages/monitor/src/scheduler.ts:134

Get schedule summary for all dependencies

Parameters

ParameterTypeDescription
dependenciesDependencyEntry[]Array of dependencies
configDependabitConfigConfiguration

Returns

ts
{
  daily: number;
  disabled: number;
  hourly: number;
  monthly: number;
  weekly: number;
}

Schedule summary grouped by frequency

NameTypeDefined in
dailynumberpackages/monitor/src/scheduler.ts:139
disablednumberpackages/monitor/src/scheduler.ts:142
hourlynumberpackages/monitor/src/scheduler.ts:138
monthlynumberpackages/monitor/src/scheduler.ts:141
weeklynumberpackages/monitor/src/scheduler.ts:140

shouldCheckDependency()

ts
shouldCheckDependency(
   dependency, 
   config, 
   currentTime?): boolean;

Defined in: packages/monitor/src/scheduler.ts:30

Check if a dependency should be checked now

Parameters

ParameterTypeDescription
dependencyDependencyEntryDependency entry
configDependabitConfigConfiguration
currentTimeDateCurrent time (defaults to now)

Returns

boolean

true if dependency should be checked

Released under the MIT License.