Class CronDate

CronDate class that wraps the Luxon DateTime object to provide a consistent API for working with dates and times in the context of cron.

Constructors

constructor

new CronDate(
timestamp?: string | number | CronDate | Date,
tz?: string,
): CronDate
Constructs a new CronDate instance.
Parameters
- Optionaltimestamp: string | number | CronDate | Date
  The timestamp to initialize the CronDate with.
- Optionaltz: string
  The timezone to use for the CronDate.
Returns CronDate
- Defined in CronDate.ts:59

Accessors

dstEnd

get dstEnd(): null | number
Returns daylight savings end time.

Returns null | number
- Defined in CronDate.ts:121
set dstEnd(value: null | number): void
Sets daylight savings end time.
Parameters
- value: null | number
Returns void
- Defined in CronDate.ts:129

dstStart

get dstStart(): null | number
Returns daylight savings start time.

Returns null | number
- Defined in CronDate.ts:105
set dstStart(value: null | number): void
Sets daylight savings start time.
Parameters
- value: null | number
Returns void
- Defined in CronDate.ts:113

Methods

addDay

addDay(): void
Adds one day to the current CronDate.

Returns void
- Defined in CronDate.ts:150

addHour

addHour(): void
Adds one hour to the current CronDate.

Returns void
- Defined in CronDate.ts:157

addMinute

addMinute(): void
Adds one minute to the current CronDate.

Returns void
- Defined in CronDate.ts:164

addMonth

addMonth(): void
Adds one month to the current CronDate.

Returns void
- Defined in CronDate.ts:143

addSecond

addSecond(): void
Adds one second to the current CronDate.

Returns void
- Defined in CronDate.ts:171

addUnit

addUnit(unit: TimeUnit): void
Adds a unit of time to the current CronDate.
Parameters
- unit: TimeUnit
Returns void
- Defined in CronDate.ts:226

addYear

addYear(): void
Adds one year to the current CronDate.

Returns void
- Defined in CronDate.ts:136

applyDateOperation

applyDateOperation(op: DateMathOp, unit: TimeUnit, hoursLength?: number): void
Primarily for internal use.
Parameters
- op: DateMathOp
  The operation to perform.
- unit: TimeUnit
  The unit of time to use.
- OptionalhoursLength: number
  The length of the hours. Required when unit is not month or day.
Returns void
- Defined in CronDate.ts:525

getDate

getDate(): number
Returns the day.

Returns number
- Defined in CronDate.ts:260

getDay

getDay(): number
Returns the day of the week.

Returns number
- Defined in CronDate.ts:276

getFullYear

getFullYear(): number
Returns the year.

Returns number
- Defined in CronDate.ts:268

getHours

getHours(): number
Returns the hour.

Returns number
- Defined in CronDate.ts:293

getMilliseconds

getMilliseconds(): number
Returns the milliseconds.

Returns number
- Defined in CronDate.ts:317

getMinutes

getMinutes(): number
Returns the minutes.

Returns number
- Defined in CronDate.ts:301

getMonth

getMonth(): number
Returns the month.

Returns number
- Defined in CronDate.ts:285

getSeconds

getSeconds(): number
Returns the seconds.

Returns number
- Defined in CronDate.ts:309

getTime

getTime(): number
Returns the time.

Returns number
- Defined in CronDate.ts:325

getUTCDate

getUTCDate(): number
Returns the UTC day.

Returns number
- Defined in CronDate.ts:333

getUTCDay

getUTCDay(): number
Returns the UTC day of the week.

Returns number
- Defined in CronDate.ts:349

getUTCFullYear

getUTCFullYear(): number
Returns the UTC year.

Returns number
- Defined in CronDate.ts:341

getUTCHours

getUTCHours(): number
Returns the UTC hour.

Returns number
- Defined in CronDate.ts:366

getUTCMinutes

getUTCMinutes(): number
Returns the UTC minutes.

Returns number
- Defined in CronDate.ts:374

getUTCMonth

getUTCMonth(): number
Returns the UTC month.

Returns number
- Defined in CronDate.ts:358

getUTCSeconds

getUTCSeconds(): number
Returns the UTC seconds.

Returns number
- Defined in CronDate.ts:382

invokeDateOperation

invokeDateOperation(verb: DateMathOp, unit: TimeUnit): void
Handles a math operation.
Parameters
- verb: DateMathOp
  {'add' | 'subtract'}
- unit: TimeUnit
  {'year' | 'month' | 'day' | 'hour' | 'minute' | 'second'}
Returns void
- Defined in CronDate.ts:243

isLastDayOfMonth

isLastDayOfMonth(): boolean
Returns true if the day is the last day of the month.

Returns boolean
- Defined in CronDate.ts:486

isLastWeekdayOfMonth

isLastWeekdayOfMonth(): boolean
Returns true if the day is the last weekday of the month.

Returns boolean
- Defined in CronDate.ts:503

setDate

setDate(d: number): void
Sets the day.
Parameters
- d: number
Returns void
- Defined in CronDate.ts:406

setDay

setDay(d: number): void
Sets the day of the week.
Parameters
- d: number
Returns void
- Defined in CronDate.ts:422

setFullYear

setFullYear(y: number): void
Sets the year.
Parameters
- y: number
Returns void
- Defined in CronDate.ts:414

setHours

setHours(h: number): void
Sets the hour.
Parameters
- h: number
Returns void
- Defined in CronDate.ts:438

setMilliseconds

setMilliseconds(s: number): void
Sets the milliseconds.
Parameters
- s: number
Returns void
- Defined in CronDate.ts:462

setMinutes

setMinutes(m: number): void
Sets the minutes.
Parameters
- m: number
Returns void
- Defined in CronDate.ts:446

setMonth

setMonth(m: number): void
Sets the month.
Parameters
- m: number
Returns void
- Defined in CronDate.ts:430

setSeconds

setSeconds(s: number): void
Sets the seconds.
Parameters
- s: number
Returns void
- Defined in CronDate.ts:454

subtractDay

subtractDay(): void
Subtracts one day from the current CronDate. If the day is 1, it will subtract one month instead.

Returns void
- Defined in CronDate.ts:194

subtractHour

subtractHour(): void
Subtracts one hour from the current CronDate. If the hour is 0, it will subtract one day instead.

Returns void
- Defined in CronDate.ts:202

subtractMinute

subtractMinute(): void
Subtracts one minute from the current CronDate. If the minute is 0, it will subtract one hour instead.

Returns void
- Defined in CronDate.ts:210

subtractMonth

subtractMonth(): void
Subtracts one month from the current CronDate. If the month is 1, it will subtract one year instead.

Returns void
- Defined in CronDate.ts:186

subtractSecond

subtractSecond(): void
Subtracts one second from the current CronDate. If the second is 0, it will subtract one minute instead.

Returns void
- Defined in CronDate.ts:218

subtractUnit

subtractUnit(unit: TimeUnit): void
Subtracts a unit of time from the current CronDate.
Parameters
- unit: TimeUnit
Returns void
- Defined in CronDate.ts:234

subtractYear

subtractYear(): void
Subtracts one year from the current CronDate.

Returns void
- Defined in CronDate.ts:178

toDate

toDate(): Date
Returns the date as a Date object.

Returns Date
- Defined in CronDate.ts:478

toISOString

toISOString(): null | string
Returns the UTC milliseconds.

Returns null | string
- Defined in CronDate.ts:390

toJSON

toJSON(): null | string
Returns the date as a JSON string.

Returns null | string
- Defined in CronDate.ts:398

toString

toString(): string
Returns the date as a string.

Returns string
- Defined in CronDate.ts:470