createCronSchedule

Rôle et comportement

Analyse une expression cron à cinq champs, ou une macro comme @daily, évaluée dans un fuseau horaire IANA (UTC par défaut). Le résultat figé calcule les créneaux avec next() et previous() et ne publie rien. La construction refuse les champs invalides, les fuseaux inconnus et les expressions sans aucune occurrence.

Exemple complet et règles détaillées.

Paramètres et propriétés

• expressionRequis
  string
  Cinq champs (minute, heure, jour du mois, mois, jour de la semaine) avec listes, intervalles, pas et noms anglais de mois ou de jour à trois lettres, ou une macro comme @hourly ou @daily ; 256 caractères au plus. Les jours 0 et 7 désignent le dimanche, et quand les deux champs de jour sont restreints, un jour qui correspond à l’un ou l’autre convient.
• optionsOptionnel
  CronOptions | undefined
  Options d’évaluation ; omettez-les pour évaluer en UTC.
• options.timeZoneOptionnel
  string | undefined
  Fuseau horaire IANA dont l’heure murale est décrite par l’expression, comme Europe/Paris ; UTC par défaut.

Retour

CronSchedule

Signature

export declare function createCronSchedule(
  expression: string,
  options?: CronOptions,
): CronSchedule;

Contrats associés

• CronOptions
• CronSchedule