Class CronHour

Represents the "hour" field within a cron expression. CronHour

Hierarchy (View Summary)

Constructors

constructor

Accessors

chars isWildcard max min values chars constraints max min validChars

Methods

serialize validate sorter

Constructors

constructor

  • new CronHour(
        values: (
            | 0
            | 1
            | 2
            | 3
            | 4
            | 5
            | 6
            | 7
            | 8
            | 9
            | 10
            | 11
            | 12
            | 13
            | 14
            | 15
            | 16
            | 17
            | 18
            | 19
            | 20
            | 21
            | 22
            | 23
        )[],
        wildcard?: boolean,
    ): CronHour

  • CronHour constructor. Initializes the "hour" field with the provided values.

    Parameters

    • values: (
          | 0
          | 1
          | 2
          | 3
          | 4
          | 5
          | 6
          | 7
          | 8
          | 9
          | 10
          | 11
          | 12
          | 13
          | 14
          | 15
          | 16
          | 17
          | 18
          | 19
          | 20
          | 21
          | 22
          | 23
      )[]

      Values for the "hour" field

    • Optionalwildcard: boolean = false

      Whether this field is a wildcard

    Returns CronHour

Accessors

chars

  • get chars(): readonly string[]

  • Returns an array of allowed special characters for this field.

    Returns readonly string[]

isWildcard

  • get isWildcard(): boolean

  • Indicates whether this field is a wildcard.

    Returns boolean

max

  • get max(): number

  • Returns the maximum value allowed for this field.

    Returns number

min

  • get min(): number

  • Returns the minimum value allowed for this field.

    Returns number

values

  • get values(): (
        | 0
        | 1
        | 2
        | 3
        | 4
        | 5
        | 6
        | 7
        | 8
        | 9
        | 10
        | 11
        | 12
        | 13
        | 14
        | 15
        | 16
        | 17
        | 18
        | 19
        | 20
        | 21
        | 22
        | 23
    )[]

  • Returns an array of allowed values for the "hour" field.

    Returns (
        | 0
        | 1
        | 2
        | 3
        | 4
        | 5
        | 6
        | 7
        | 8
        | 9
        | 10
        | 11
        | 12
        | 13
        | 14
        | 15
        | 16
        | 17
        | 18
        | 19
        | 20
        | 21
        | 22
        | 23
    )[]

Staticchars

Staticconstraints

Staticmax

Staticmin

StaticvalidChars

  • get validChars(): RegExp

  • Returns the regular expression used to validate this field.

    Returns RegExp

Methods

serialize

validate

Staticsorter

  • sorter(a: string | number, b: string | number): number

  • Helper function to sort values in ascending order.

    Parameters

    • a: string | number

      First value to compare

    • b: string | number

      Second value to compare

    Returns number

    • A negative, zero, or positive value, depending on the sort order

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods