Class CronExpression

Utility class for creating cron expressions with guardrails.

Index

Methods

at between build in on daily every fromString monthly weekly

Methods

at

at<T extends CronUnit>(value: RangeForCronUnit<T>, unit: T): CronExpression
Fixes a specific field to a concrete value.
Type Parameters
- T extends CronUnit
Parameters
- value: RangeForCronUnit<T>
  The concrete value.
- unit: T
  The unit, like 'minutes', 'hours', 'days' etc.
Returns CronExpression
A cron expression to either continue working with or building the result string.
Example
```
CronExpression.every(1, 'hours').at(30, 'minutes')  // "* 30 * * * *" (at :30 past every hour)
CronExpression.daily().at(9, 'hours')               // "0 0 9 * * *"
```
- Defined in src/cron/cron-expression.utilities.ts:180

between

between<T extends CronUnit>(
    from: RangeForCronUnit<T>,
    to: RangeForCronUnit<T>,
    unit: T,
): CronExpression
Restricts execution to a range of values for a given unit.
Type Parameters
- T extends CronUnit
Parameters
- from: RangeForCronUnit<T>
  The value at which the range starts.
- to: RangeForCronUnit<T>
  The value at which the range ends.
- unit: T
  The unit, like 'minutes', 'hours', 'days' etc.
Returns CronExpression
A cron expression to either continue working with or building the result string.
Example
```
CronExpression.every(1, 'minutes').between(9, 17, 'hours')  // "* * 9-17 * * *" (business hours only)
```
Throws
If the "from" value is smaller than the "to" value.
- Defined in src/cron/cron-expression.utilities.ts:195

build

build(): CronExpressionString
Builds the final result from the builder input.

Returns CronExpressionString
The branded node-cron expression string.
- Defined in src/cron/cron-expression.utilities.ts:235

in

in(...months: [MonthName, ...MonthName[]]): CronExpression
Restricts execution to specific months.
Parameters
- ...months: [MonthName, ...MonthName[]]
  The months in which the execution should happen.
Returns CronExpression
A cron expression to either continue working with or building the result string.
Example
```
CronExpression.monthly().in('March', 'June', 'September', 'December')  // "0 0 0 1 3,6,9,12 *"
```
- Defined in src/cron/cron-expression.utilities.ts:224

on

on(...days: [DayOfWeek, ...DayOfWeek[]]): CronExpression
Restricts execution to specific days of the week.
Parameters
- ...days: [DayOfWeek, ...DayOfWeek[]]
  The days on which the execution should happen.
Returns CronExpression
A cron expression to either continue working with or building the result string.
Example
```
CronExpression.daily().on('Monday', 'Wednesday', 'Friday')  // "0 0 0 * * 1,3,5"
```
- Defined in src/cron/cron-expression.utilities.ts:212

`Static`daily

daily(): CronExpression
Runs once a day. Default: midnight (00:00:00). Chain .at() to set the time.

Returns CronExpression
A cron expression to either continue working with or building the result string.
Example
```
CronExpression.daily().at(9, 'hours').at(30, 'minutes')  // "0 30 9 * * *"
```
- Defined in src/cron/cron-expression.utilities.ts:128

`Static`every

every<T extends CronUnit>(value: RangeForCronUnit<T>, unit: T): CronExpression
Runs every N units.
Type Parameters
- T extends CronUnit
Parameters
- value: RangeForCronUnit<T>
  The interval at which to run.
- unit: T
  The unit, like 'minutes', 'hours', 'days' etc.
Returns CronExpression
A cron expression to either continue working with or building the result string.
Example
```
CronExpression.every(5, 'minutes')  // "* */5 * * * *"
CronExpression.every(2, 'hours')    // "* * */2 * * *"
```
- Defined in src/cron/cron-expression.utilities.ts:113

`Static`fromString

fromString(expression: string): CronExpressionString
Builds a CronExpression from a raw node-cron string (for interop / parsing).
Parameters
- expression: string
  The raw expression too build from.
Returns CronExpressionString
The final CronExpressionString.

Throws
If there are more than 6 parts provided.
- Defined in src/cron/cron-expression.utilities.ts:159

`Static`monthly

monthly(): CronExpression
Runs once a month. Default: 1st of the month at midnight.

Returns CronExpression
A cron expression to either continue working with or building the result string.
Example
```
CronExpression.monthly().at(15, 'days').at(6, 'hours')  // "0 0 6 15 * *"
```
- Defined in src/cron/cron-expression.utilities.ts:149

`Static`weekly

weekly(): CronExpression
Runs once a week. Default: Sunday midnight. Chain .on() and .at() to customize.

Returns CronExpression
A cron expression to either continue working with or building the result string.
Example
```
CronExpression.weekly().on('Monday').at(8, 'hours')  // "0 0 8 * * 1"
```
- Defined in src/cron/cron-expression.utilities.ts:139

Class CronExpression

Index

Methods

Methods

at

Type Parameters

Parameters

Returns CronExpression

Example

between

Type Parameters

Parameters

Returns CronExpression

Example

Throws

build

Returns CronExpressionString

in

Parameters

Returns CronExpression

Example

on

Parameters

Returns CronExpression

Example

Staticdaily

Returns CronExpression

Example

Staticevery

Type Parameters

Parameters

Returns CronExpression

Example

StaticfromString

Parameters

Returns CronExpressionString

Throws

Staticmonthly

Returns CronExpression

Example

Staticweekly

Returns CronExpression

Example

Settings

On This Page

`Static`daily

`Static`every

`Static`fromString

`Static`monthly

`Static`weekly