Skip to main content

Class: Cron

Handles Cron strings and generates dates based on the cron string provided.

See​

https://en.wikipedia.org/wiki/Cron

Constructors​

new Cron()​

new Cron(cron: string): Cron

Parameters​

ParameterTypeDescription
cronstringThe cron pattern to use

Returns​

Cron

Defined in​

cron/dist/esm/index.d.mts:62

Properties​

cron​

cron: string

Defined in​

cron/dist/esm/index.d.mts:52

days​

days: number[]

Defined in​

cron/dist/esm/index.d.mts:56

dows​

dows: number[]

Defined in​

cron/dist/esm/index.d.mts:58

hours​

hours: number[]

Defined in​

cron/dist/esm/index.d.mts:55

minutes​

minutes: number[]

Defined in​

cron/dist/esm/index.d.mts:54

months​

months: number[]

Defined in​

cron/dist/esm/index.d.mts:57

normalized​

normalized: string

Defined in​

cron/dist/esm/index.d.mts:53

normalize​

private static normalize: any

Normalize the pattern

Param​

The pattern to normalize

Defined in​

cron/dist/esm/index.d.mts:79

parsePart​

private static parsePart: any

Parse the current part

Param​

The part of the pattern to parse

Param​

The id that identifies the current part

Defined in​

cron/dist/esm/index.d.mts:90

parseString​

private static parseString: any

Parse the pattern

Param​

The pattern to parse

Defined in​

cron/dist/esm/index.d.mts:84

Methods​

next()​

next(outset?: Date, origin?: boolean): Date

Get the next date that matches with the current pattern

Parameters​

ParameterTypeDescription
outset?DateThe Date instance to compare with
origin?booleanWhether this next call is origin

Returns​

Date

Defined in​

cron/dist/esm/index.d.mts:68

toString()​

toString(): string

Returns the string that represents this cron pattern

Returns​

string

The string that represents this cron pattern

Defined in​

cron/dist/esm/index.d.mts:74