Class CronExpression

Class representing a Cron expression.

Index

Constructors

Accessors

Methods

[iterator] hasNext hasPrev includesDate next prev reset stringify take toString fieldsToExpression

Constructors

constructor

new CronExpression(
fields: CronFieldCollection,
options: CronExpressionOptions,
): CronExpression
Creates a new CronExpression instance.
Parameters
- fields: CronFieldCollection
  Cron fields.
- options: CronExpressionOptions
  Parser options.
Returns CronExpression
- Defined in CronExpression.ts:49

Accessors

fields

get fields(): CronFieldCollection
Getter for the cron fields.

Returns CronFieldCollection
Cron fields.
- Defined in CronExpression.ts:74

Methods

[iterator]

"[iterator]"(): Iterator<CronDate>
Returns an iterator for iterating through future CronDate instances

Returns Iterator<CronDate>
An iterator object for CronExpression that returns CronDate values.

Name
Symbol.iterator

Memberof
CronExpression
- Defined in CronExpression.ts:574

hasNext

hasNext(): boolean
Check if there is a next scheduled date based on the current date and cron expression.

Returns boolean
- Returns true if there is a next scheduled date, false otherwise.
Memberof
CronExpression
- Defined in CronExpression.ts:253

hasPrev

hasPrev(): boolean
Check if there is a previous scheduled date based on the current date and cron expression.

Returns boolean
- Returns true if there is a previous scheduled date, false otherwise.
Memberof
CronExpression
- Defined in CronExpression.ts:272

includesDate

includesDate(date: CronDate | Date): boolean
Check if the cron expression includes the given date
Parameters
- date: CronDate | Date
Returns boolean
- Defined in CronExpression.ts:340

next

next(): CronDate
Find the next scheduled date based on the cron expression.

Returns CronDate
- The next scheduled date or an ES6 compatible iterator object.
Memberof
CronExpression
- Defined in CronExpression.ts:233

prev

prev(): CronDate
Find the previous scheduled date based on the cron expression.

Returns CronDate
- The previous scheduled date or an ES6 compatible iterator object.
Memberof
CronExpression
- Defined in CronExpression.ts:243

reset

reset(newDate?: CronDate | Date): void
Reset the iterators current date to a new date or the initial date.
Parameters
- OptionalnewDate: CronDate | Date
  Optional new date to reset to. If not provided, it will reset to the initial date.
Returns void

Memberof
CronExpression
- Defined in CronExpression.ts:320

stringify

stringify(includeSeconds?: boolean): string
Generate a string representation of the cron expression.
Parameters
- OptionalincludeSeconds: boolean = false
  Whether to include the seconds field in the string representation.
Returns string
- The string representation of the cron expression.
Memberof
CronExpression
- Defined in CronExpression.ts:331

take

take(limit: number): CronDate[]
Iterate over a specified number of steps and optionally execute a callback function for each step.
Parameters
- limit: number
Returns CronDate[]
- An array of iterator fields or CronDate objects.
Memberof
CronExpression
- Defined in CronExpression.ts:292

toString

toString(): string
Returns the string representation of the cron expression.

Returns string
- The next schedule date.
- Defined in CronExpression.ts:366

`Static`fieldsToExpression

fieldsToExpression(
fields: CronFieldCollection,
options?: CronExpressionOptions,
): CronExpression
Converts cron fields back to a CronExpression instance.
Parameters
- fields: CronFieldCollection
  The input cron fields object.
- Optionaloptions: CronExpressionOptions
  Optional parsing options.
Returns CronExpression
- A new CronExpression instance.
- Defined in CronExpression.ts:86