Class CronField`Abstract`

Represents a field within a cron expression. This is a base class and should not be instantiated directly. CronField

Hierarchy (View Summary)

CronField

Index

Constructors

Accessors

chars isWildcard max min values chars constraints max min validChars

Methods

serialize validate sorter

Constructors

`Protected`constructor

new CronField(values: (string | number)[], wildcard?: boolean): CronField
CronField constructor. Initializes the field with the provided values.
Parameters
- values: (string | number)[]
  Values for this field
- Optionalwildcard: boolean = false
  Whether this field is a wildcard
Returns CronField
Throws
if the constructor is called directly

Throws
if validation fails
- Defined in fields/CronField.ts:62

Accessors

chars

get chars(): readonly string[]
Returns an array of allowed special characters for this field.

Returns readonly string[]
- Defined in fields/CronField.ts:98

isWildcard

get isWildcard(): boolean
Indicates whether this field is a wildcard.

Returns boolean
- Defined in fields/CronField.ts:107

max

get max(): number
Returns the maximum value allowed for this field.

Returns number
- Defined in fields/CronField.ts:89

min

get min(): number
Returns the minimum value allowed for this field.

Returns number
- Defined in fields/CronField.ts:80

values

get values(): CronFieldType
Returns an array of allowed values for this field.

Returns CronFieldType
- Defined in fields/CronField.ts:115

`Static`chars

get chars(): readonly CronChars[]
Returns the allowed characters for this field.

Returns readonly CronChars[]
- Defined in fields/CronField.ts:36

`Static`constraints

get constraints(): CronConstraints
Returns the constraints for this field.

Returns CronConstraints
- Defined in fields/CronField.ts:51

`Static`max

get max(): CronMax
Returns the maximum value allowed for this field.

Returns CronMax
- Defined in fields/CronField.ts:28

`Static`min

get min(): CronMin
Returns the minimum value allowed for this field.

Returns CronMin
- Defined in fields/CronField.ts:20

`Static`validChars

get validChars(): RegExp
Returns the regular expression used to validate this field.

Returns RegExp
- Defined in fields/CronField.ts:44

Methods

serialize

serialize(): SerializedCronField
Serializes the field to an object.

Returns SerializedCronField
Todo
This is really only for debugging, should it be removed?
- Defined in fields/CronField.ts:138

validate

validate(): void
Validates the field values against the allowed range and special characters.

Returns void
Throws
if validation fails
- Defined in fields/CronField.ts:149

`Static`sorter

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
- Defined in fields/CronField.ts:125