Class CronExpressionHelper

Utility class for cron expression parsing and evaluation

Index

Constructors

Methods

GetMinIntervalMs GetNextRunTime IsExpressionDue ValidateExpression

Constructors

constructor

new CronExpressionHelper(): CronExpressionHelper
Returns CronExpressionHelper

Methods

`Static`GetMinIntervalMs

GetMinIntervalMs(
    cronExpression: string,
    timezone: string,
    sampleSize?: number,
    fromDate?: Date,
): number
Estimate the minimum interval (in ms) between consecutive executions of a cron expression by sampling the next several runs and returning the smallest gap. Returns Number.POSITIVE_INFINITY if the expression cannot be parsed or yields fewer than two runs in the sample window.
Parameters
- cronExpression: string
  Cron expression string
- timezone: string
  IANA timezone
- sampleSize: number = 6
  Number of consecutive runs to sample (default: 6)
- OptionalfromDate: Date
  Optional date to start sampling from (defaults to now)
Returns number
- Defined in Scheduling/engine/src/CronExpressionHelper.ts:80

`Static`GetNextRunTime

GetNextRunTime(cronExpression: string, timezone: string, fromDate?: Date): Date
Get the next execution time for a cron expression
Parameters
- cronExpression: string
  Cron expression string
- timezone: string
  IANA timezone
- OptionalfromDate: Date
  Optional date to calculate from (defaults to now)
Returns Date
Next execution date
- Defined in Scheduling/engine/src/CronExpressionHelper.ts:51

`Static`IsExpressionDue

IsExpressionDue(
    cronExpression: string,
    timezone: string,
    evalTime: Date,
): boolean
Determine if a cron expression is currently due
Parameters
- cronExpression: string
  Cron expression string
- timezone: string
  IANA timezone (e.g., 'America/Chicago')
- evalTime: Date
  Time to evaluate against
Returns boolean
True if the expression is due at evalTime
- Defined in Scheduling/engine/src/CronExpressionHelper.ts:21

`Static`ValidateExpression

ValidateExpression(cronExpression: string): ValidationResult
Validate a cron expression
Parameters
- cronExpression: string
  Cron expression to validate
Returns ValidationResult
Validation result
- Defined in Scheduling/engine/src/CronExpressionHelper.ts:116