Class CronFieldCollection

Represents a complete set of cron fields. CronFieldCollection

Constructors

  • CronFieldCollection constructor. Initializes the cron fields with the provided values.

    Parameters

    • param0: CronFields

      The cron fields values

    Returns CronFieldCollection

    if validation fails

    const cronFields = new CronFieldCollection({
    second: new CronSecond([0]),
    minute: new CronMinute([0, 30]),
    hour: new CronHour([9]),
    dayOfMonth: new CronDayOfMonth([15]),
    month: new CronMonth([1]),
    dayOfWeek: new CronDayOfTheWeek([1, 2, 3, 4, 5]),
    })

    console.log(cronFields.second.values); // [0]
    console.log(cronFields.minute.values); // [0, 30]
    console.log(cronFields.hour.values); // [9]
    console.log(cronFields.dayOfMonth.values); // [15]
    console.log(cronFields.month.values); // [1]
    console.log(cronFields.dayOfWeek.values); // [1, 2, 3, 4, 5]

Accessors

Methods

  • Returns a serialized representation of the cron fields values.

    Returns SerializedCronFields

    An object containing the cron field values

  • Returns a string representation of the cron field values.

    Parameters

    • includeSeconds: boolean = false

      Whether to include seconds in the output

    Returns string

    The formatted cron string

  • Returns a string representation of the cron fields.

    Parameters

    Returns string

    • The stringified cron field
  • Returns a string representation of the cron fields.

    Parameters

    • input: (number | CronChars)[]

      The cron fields values

    Returns FieldRange[]

    • The compacted cron fields
  • Creates a new CronFieldCollection instance by partially overriding fields from an existing one.

    Parameters

    • base: CronFieldCollection

      The base CronFieldCollection to copy fields from

    • fields: CronFieldOverride

      The fields to override, can be CronField instances or raw values

    Returns CronFieldCollection

    A new CronFieldCollection instance

    const base = new CronFieldCollection({
    second: new CronSecond([0]),
    minute: new CronMinute([0]),
    hour: new CronHour([12]),
    dayOfMonth: new CronDayOfMonth([1]),
    month: new CronMonth([1]),
    dayOfWeek: new CronDayOfWeek([1])
    });

    // Using CronField instances
    const modified1 = CronFieldCollection.from(base, {
    hour: new CronHour([15]),
    minute: new CronMinute([30])
    });

    // Using raw values
    const modified2 = CronFieldCollection.from(base, {
    hour: [15], // Will create new CronHour
    minute: [30] // Will create new CronMinute
    });