cronnor/types/cronexp.d.ts

Bibliothèque JavaScript implémentant un programme cron.

/**
 * @import Field from "./field.js"
 */
/**
 * La classe d'une expression _cron_.
 *
 * @class
 */
export default class CronExp {
    /**
     * Crée une expression _cron_.
     *
     * @param {string} pattern Le motif de l'expression _cron_.
     * @throws {Error}      Si la syntaxe du motif est incorrecte.
     * @throws {RangeError} Si un intervalle est invalide (hors limite ou quand
     *                      la borne supérieure est plus petite que la borne
     *                      inférieure).
     * @throws {TypeError}  Si le constructeur est appelé sans le mot clé `new`
     *                      ou si le motif n'est pas une chaine de caractères.
     */
    constructor(pattern: string);
    /**
     * Teste si une date respecte l'expression.
     *
     * @param {Date} [date] La date qui sera testée (ou l'instant présent par
     *                      défaut).
     * @returns {boolean} `true` si l'expression est respectée ; sinon `false`.
     */
    test(date?: Date): boolean;
    /**
     * Calcule la prochaine date respectant l'expression.
     *
     * @param {Date} [start] La date de début (ou l'instant présent par défaut).
     * @returns {Date} La prochaine date respectant l'expression.
     */
    next(start?: Date): Date;
    #private;
}