Class CronBuilder

Privateconstructor

• new CronBuilder(state: CronObject, field?: CronFieldName): CronBuilder

  Parameters

  • state: CronObject
  • Optionalfield: CronFieldName

  Returns CronBuilder

Private Optional Readonlyfield

Private Readonlystate

Private Staticparser

Privatedef

• get def(): FieldDefinition

  Get the currently selected field definition.

  Returns FieldDefinition

PrivatebuildExpr

• buildExpr(values: (string | number)[]): string

  Build a field expression string.

  Parameters

  • values: (string | number)[]

  Returns string

Privateclamp

• clamp(value: number): number

  Clamp a cron field value to its allowed range.

  Parameters

  • value: number

  Returns number

dayOfMonth

• dayOfMonth(): CronBuilder

  Select the day of month field.

  Returns CronBuilder

dayOfWeek

• dayOfWeek(): CronBuilder

  Select the day of week field.

  Returns CronBuilder

every

• every(step: number, range?: [number, number]): CronBuilder

  Define step expression.

  Parameters

  • step: number
  • Optionalrange: [number, number]

  Returns CronBuilder

hour

• hour(): CronBuilder

  Select the hour field.

  Returns CronBuilder

list

• list(...values: (string | number)[]): CronBuilder

  Set full list of values.

  Parameters

  • ...values: (string | number)[]

  Returns CronBuilder

minute

• minute(): CronBuilder

  Select the minute field.

  Returns CronBuilder

month

• month(): CronBuilder

  Select the month field.

  Returns CronBuilder

Privatenext

• next(state?: Partial<CronObject>, current?: CronFieldName): CronBuilder

  Create a new builder with updated state.

  Parameters

  • state: Partial<CronObject> = {}
  • Optionalcurrent: CronFieldName

  Returns CronBuilder

range

• range(from: number, to: number): CronBuilder

  Define a range (min -> max).

  Parameters

  • from: number
  • to: number

  Returns CronBuilder

PrivaterequireField

• requireField(): CronFieldName

  Ensure a cron field has been selected.

  Returns CronFieldName

Privateresolve

• resolve(value: string | number): string

  Resolve any input into a cron field expression string.

  Parameters

  • value: string | number

  Returns string

Privateset

• set(expr: string): CronBuilder

  Update the current cron field.

  Parameters

  • expr: string

  Returns CronBuilder

toObject

• toObject(): CronObject

  Output as structured cron object.

  Returns CronObject

toString

• toString(): string

  Output as standard 5-field cron expression string.

  Returns string

toTuple

• toTuple(): CronTuple

  Returns CronTuple

Privatevalidate

• validate(value: string | number): number

  Validate a cron field value against its allowed range.

  Parameters

  • value: string | number

  Returns number

value

• value(value: string | number): CronBuilder

  Set explicit value.

  Parameters

  • value: string | number

  Returns CronBuilder

Staticcreate

• create(expr?: string | Partial<CronObject>): CronBuilder

  Create a builder instance from a optional cron expression.

  Parameters

  • Optionalexpr: string | Partial<CronObject>

    Optional standard 5-field cron string, a partial cron object or special alias.

  Returns CronBuilder

  The current cron builder instance.

  Example

  CronBuilder.create()
  CronBuilder.create( '0 2 0 JAN MON-FRI' )
  CronBuilder.create( { minute: '30', hour: '1' } )
  CronBuilder.create( '@daily' )
  Copy