@types/cron

What is @types/cron?

@types/cron provides TypeScript type definitions for the cron package, which is used for scheduling jobs in Node.js applications. It allows developers to define and manage cron jobs with type safety.

What are @types/cron's main functionalities?

Creating a Cron Job

This feature allows you to create a cron job that runs a specified function at a scheduled time. In this example, the job is scheduled to run every day at midnight.

const cron = require('cron');
const CronJob = cron.CronJob;
const job = new CronJob('0 0 * * *', function() {
  console.log('You will see this message every day at midnight');
});
job.start();

Stopping a Cron Job

This feature allows you to stop a running cron job. In this example, the job is stopped after 10 seconds.

const cron = require('cron');
const CronJob = cron.CronJob;
const job = new CronJob('0 0 * * *', function() {
  console.log('You will see this message every day at midnight');
});
job.start();
// Stop the job after some time
setTimeout(() => {
  job.stop();
  console.log('Job stopped');
}, 10000);

Specifying Time Zones

This feature allows you to specify the time zone for the cron job. In this example, the job is scheduled to run every day at midnight in the 'America/Los_Angeles' time zone.

const cron = require('cron');
const CronJob = cron.CronJob;
const job = new CronJob({
  cronTime: '0 0 * * *',
  onTick: function() {
    console.log('You will see this message every day at midnight in the specified time zone');
  },
  timeZone: 'America/Los_Angeles'
});
job.start();

Other packages similar to @types/cron

node-cron

node-cron is a lightweight npm package for scheduling tasks in Node.js using cron syntax. It is similar to cron but does not require any external dependencies. It is simpler and more lightweight compared to cron.

agenda

agenda is a light-weight job scheduling library for Node.js. It offers more advanced features like job persistence in MongoDB, job priority, and concurrency control. It is more feature-rich compared to cron.

bree

bree is a job scheduler for Node.js with support for cron syntax, human-readable intervals, and worker threads. It is designed to be simple and fast, with additional features like graceful shutdown and job retries. It offers more modern features compared to cron.

README

This is a stub types definition for @types/cron (https://github.com/kelektiv/node-cron#readme).

cron provides its own type definitions, so you don't need @types/cron installed!