@types/cron

Create a new ```CronJob```.

Parameter cronTime

The time to fire off your job. This can be in the form of cron syntax or a JS ```Date``` object.

Parameter onTick

The function to fire at the specified time.

Parameter onComplete

A function that will fire when the job is complete, when it is stopped.

Parameter startNow

Specifies whether to start the job just before exiting the constructor. By default this is set to false. If left at default you will need to call ```job.start()``` in order to start the job (assuming ```job``` is the variable you set the cronjob to). This does not immediately fire your onTick function, it just gives you more control over the behavior of your jobs.

Parameter timeZone

Specify the timezone for the execution. This will modify the actual time relative to your timezone. If the timezone is invalid, an error is thrown. Can be any string accepted by luxon's ```DateTime.setZone()``` (https://moment.github.io/luxon/api-docs/index.html#datetimesetzone).

Parameter context

The context within which to execute the onTick method. This defaults to the cronjob itself allowing you to call ```this.stop()```. However, if you change this you'll have access to the functions and values within your context object.

Parameter runOnInit

This will immediately fire your ```onTick``` function as soon as the requisit initialization has happened. This option is set to ```false``` by default for backwards compatibility.

Parameter utcOffset

This allows you to specify the offset of your timezone rather than using the ```timeZone``` param. Probably don't use both ```timeZone``` and ```utcOffset``` together or weird things may happen.

Parameter unrefTimeout

If you have code that keeps the event loop running and want to stop the node process when that finishes regardless of the state of your cronjob, you can do so making use of this parameter. This is off by default and cron will run as if it needs to control the event loop. For more information take a look at [timers#timers_timeout_unref](https://nodejs.org/api/timers.html#timers_timeout_unref) from the NodeJS docs.

Create a new ```CronJob```.

Parameter options

Job parameters.

Function using to fire ```onTick```, default set to an inner private function. Overwrite this only if you have a really good reason to do so.

Return ```true``` if job is running.

Add another ```onTick``` function.

Parameter callback

Target function.

Tells you the last execution date.

Tells you when a ```CronTime``` will be run.

Tells you when a ```CronTime``` will be run.

Parameter i

Indicate which turn of run after now. If not given return next run time.

Returns

A DateTime when the cronTime passed in the constructor is a Date or a DateTime and an array of DateTime when the cronTime is a string.

Change the time for the ```CronJob```.

Parameter time

Target time.

Runs your job.

Stops your job.

Create a new ```CronTime```.

Parameter source

The time to fire off your job. This can be in the form of cron syntax, a JS ```Date``` object, or a luxon ```DateTime``` object.

Parameter zone

Timezone name. Can be any string accepted by luxon's ```DateTime.setZone()``` (https://moment.github.io/luxon/api-docs/index.html#datetimesetzone).

Parameter utcOffset

UTC offset. Don't use both ```zone``` and ```utcOffset``` together or weird things may happen.

Get the number of milliseconds in the future at which to fire our callbacks.

Tells you when ```CronTime``` will be run.

Tells you when ```CronTime``` will be run.

Parameter i

Indicate which turn of run after now. If not given return next run time.

Returns

A ```DateTime``` when the source passed in the constructor is a ```Date``` or a ```DateTime``` and an array of ```DateTime``` when the source is a string.

The context within which to execute the onTick method. This defaults to the cronjob itself allowing you to call ```this.stop()```. However, if you change this you'll have access to the functions and values within your context object.

The time to fire off your job. This can be in the form of cron syntax, a JS ```Date``` object, or a luxon ```DateTime``` object.

A function that will fire when the job is stopped with ```job.stop()```, and may also be called by ```onTick``` at the end of each run.

The function to fire at the specified time. If an ```onComplete``` callback was provided, ```onTick``` will receive it as an argument. ```onTick``` may call ```onComplete``` when it has finished its work.

This will immediately fire your ```onTick``` function as soon as the requisit initialization has happened. This option is set to ```false``` by default for backwards compatibility.

Specifies whether to start the job just before exiting the constructor. By default this is set to false. If left at default you will need to call ```job.start()``` in order to start the job (assuming ```job``` is the variable you set the cronjob to). This does not immediately fire your ```onTick``` function, it just gives you more control over the behavior of your jobs.

Specify the timezone for the execution. This will modify the actual time relative to your timezone. If the timezone is invalid, an error is thrown. Can be any string accepted by luxon's ```DateTime.setZone()``` (https://moment.github.io/luxon/api-docs/index.html#datetimesetzone). Probably don't use both ```timeZone``` and ```utcOffset``` together or weird things may happen.

If you have code that keeps the event loop running and want to stop the node process when that finishes regardless of the state of your cronjob, you can do so making use of this parameter. This is off by default and cron will run as if it needs to control the event loop. For more information take a look at [timers#timers_timeout_unref](https://nodejs.org/api/timers.html#timers_timeout_unref) from the NodeJS docs.

This allows you to specify the offset of your timezone rather than using the ```timeZone``` param. Probably don't use both ```timeZone``` and ```utcOffset``` together or weird things may happen.