cron、node-cron、node-schedule は、Node.js アプリケーション内で定型的なタスク(バッチ処理、データ同期、清掃作業など)を自動的に実行するためのライブラリです。これらはすべて UNIX 系の cron 構文をベースにしていますが、実装のアプローチや機能の豊かさが異なります。cron は最も歴史が古く標準的ですが、現在はメンテナンスが停止しており、新しいプロジェクトでの使用は推奨されません。node-cron は軽量でシンプルであり、cron 構文による基本的なスケジューリングに特化しています。一方、node-schedule は cron 構文に加えて、人間が読みやすい自然言語のようなルールや、特定の Date オブジェクトを指定する柔軟なスケジューリング機能を提供します。
バックグラウンドジョブの実行は、Web アプリケーションにおいてデータのエクスポート、定期清掃、外部 API との同期など、欠かせない要素です。Node.js エコシステムには cron、node-cron、node-schedule という 3 つの主要な選択肢がありますが、これらは似て非なるものです。特に、最も有名な cron パッケージが実は「死んでいる」ことをご存知でしょうか?本稿では、現役のエンジニア視点でこれらを技術的に比較し、適切な選択ができるよう解説します。
cron パッケージの現状まず結論から述べます。cron パッケージは非推奨(deprecated)です。
長年デファクトスタンダードとして使われてきましたが、現在はメンテナンスが停止しており、npm のページでも明確に非推奨である旨が記載されています。セキュリティ脆弱性への対応や、新しい Node.js バージョンへの追従が期待できません。
// ❌ 非推奨:新しいプロジェクトで使用してはいけません
const CronJob = require('cron').CronJob;
const job = new CronJob('* * * * *', () => {
console.log('This package is deprecated!');
});
job.start();
推奨アクション: 既存プロジェクトで cron を使っている場合は、node-cron または node-schedule への移行を計画してください。以降の比較では、実質的な選択肢である node-cron と node-schedule に焦点を当てます。
両ライブラリとも、標準的な 5 桁〜6 桁の cron 構文(分 時 日 月 曜日)をサポートしています。しかし、API の設計思想に違いがあります。
node-cron は、関数呼び出しで完結するシンプルさを重視しています。設定オプションも最小限に抑えられています。
// node-cron: シンプルな関数呼び出し
const cron = require('node-cron');
// 毎分実行
const task = cron.schedule('* * * * *', () => {
console.log('Running every minute via node-cron');
});
// 一時停止と再開
// task.pause();
// task.resume();
node-schedule は、オブジェクト指向的なアプローチを取り、ジョブ自体をインスタンスとして管理します。これにより、ジョブの状態管理が容易になります。
// node-schedule: インスタンスベースの管理
const schedule = require('node-schedule');
// 毎分実行
const job = schedule.scheduleJob('* * * * *', () => {
console.log('Running every minute via node-schedule');
});
// キャンセル(完全停止)
// job.cancel();
ここが両者の最大の違いです。node-cron は純粋な cron 構文のみに依存しますが、node-schedule はそれ以外の豊富なルール定義をサポートしています。
node-schedule は、cron 構文を使わずに「毎月の最終金曜日」や「毎日の午後 5 時」といったルールを直感的に記述できます。これは、cron 構文を覚えるのが面倒な場合や、可読性を高めたい場合に強力な武器になります。
// node-schedule: 人間可读なルール
const schedule = require('node-schedule');
// 毎月の最終金曜日の午後 5 時に実行
const rule = new schedule.RecurrenceRule();
rule.dayOfWeek = 5; // 金曜日
rule.hour = 17;
rule.minute = 0;
rule.month = null;
rule.date = null; // 特定の日付ではなく、ルールベース
// ※正確な「最終金曜日」のロジックは追加の判定が必要ですが、
// 以下のように特定のパターンを直接指定することも可能です
const job1 = schedule.scheduleJob('0 17 * * 5', () => {
console.log('Every Friday at 5 PM');
});
// Date オブジェクトを直接指定して「一度きり」の実行も可能
const date = new Date(Date.now() + 60000); // 1 分後
const job2 = schedule.scheduleJob(date, () => {
console.log('Runs once at specific time');
});
node-cron は、複雑な条件(例:祝日を除外する、特定の日のみ実行するなど)を cron 構文だけで表現しようとする必要があり、構文が複雑になりがちです。Date オブジェクトを直接渡すような機能はありません。
// node-cron: cron 構文のみ
const cron = require('node-cron');
// 毎週金曜日の午後 5 時(cron 構文で表現)
const task = cron.schedule('0 17 * * 5', () => {
console.log('Every Friday at 5 PM');
});
// Date オブジェクトでの一度きり実行は標準機能として提供されていない
// 自分で setTimeout 等を組み合わせる必要がある
実行中のジョブをどう制御するかという点でも、設計思想の違いが表れています。
node-cron は、ジョブの「一時停止(pause)」と「再開(resume)」をサポートしています。これは、メンテナンスモード中にジョブを一時的に止めたい場合などに便利です。
// node-cron: 一時停止と再開
const task = cron.schedule('* * * * *', () => {
console.log('Tick...');
});
// 実行を一時停止(カウントは続くが、コールバックは呼ばれない)
task.pause();
// 再開
task.resume();
// 完全停止(破棄)
task.stop();
node-schedule は、ジョブの「キャンセル(cancel)」に重点を置いています。一度キャンセルされたジョブは再度スケジュールし直す必要がありますが、ジョブの一意性を保ちやすい設計です。
// node-schedule: キャンセルと再スケジュール
const job = schedule.scheduleJob('* * * * *', () => {
console.log('Tick...');
});
// ジョブをキャンセル(削除)
job.cancel();
// 再度スケジュールするには新しいジョブを作成する必要がある
const newJob = schedule.scheduleJob('* * * * *', () => {
console.log('Rescheduled...');
});
アーキテクチャの観点から、依存関係の少なさは重要な要素です。
node-cron: 依存関係が非常に少なく、軽量です。ビルドサイズを気にする環境や、シンプルなスクリプトでは有利に働きます。内部実装もシンプルで、予期せぬ動作が少ない傾向にあります。node-schedule: 多機能であるため、内部で日付計算ライブラリ(long-timeout など)に依存しています。機能性と引き換えに、若干のオーバーヘッドが発生しますが、現代のサーバー環境では無視できるレベルです。| 特徴 | cron (非推奨) | node-cron | node-schedule |
|---|---|---|---|
| メンテナンス状況 | ❌ 停止中 | ✅ 活発 | ✅ 活発 |
| cron 構文サポート | ✅ | ✅ | ✅ |
| Date オブジェクト指定 | ⚠️ 限定的 | ❌ なし | ✅ あり |
| 自然言語ルール | ❌ | ❌ | ✅ あり (RecurrenceRule) |
| 一時停止/再開 | ✅ | ✅ | ❌ (キャンセル中心) |
| 依存関係 | 中 | 少 | 中 |
| 推奨度 | 避けるべき | シンプル用途に | 複雑用途に |
選択の基準は、あなたのプロジェクトが「単純さ」を求めるか、「柔軟性」を求めるかです。
node-cron を選ぶべきケース:
node-schedule を選ぶべきケース:
総評: 迷ったら node-schedule が安全な選択肢です。cron 構文もサポートしているため、単純なタスクにも対応できつつ、将来的に要件が複雑になっても拡張性が保証されています。ただし、本当にシンプルな定时実行だけであれば、node-cron の軽快さは魅力的です。いずれにせよ、古い cron パッケージを使い続ける理由はありません。
このパッケージは公式に非推奨(deprecated)となっており、新しいプロジェクトでは絶対に使用すべきではありません。既存のレガシーコードを維持する場合を除き、メンテナンスが継続されている node-cron または node-schedule への移行を検討してください。セキュリティ修正やバグフィックスが受けられないリスクがあります。
シンプルな cron 構文(例:毎分、毎時、毎週月曜日)だけで要件が満たせる場合に選択します。余計な機能を持たず軽量であるため、マイクロサービスやサーバーレス関数など、バンドルサイズや起動時間を気にする環境に適しています。複雑な日付計算や動的なスケジューリング変更が必要ない場合に最適です。
cron 構文だけでなく、「毎月の最終金曜日」や「特定の時刻」など、より柔軟で直感的なスケジューリングルールが必要な場合に選択します。実行中のジョブを動的にキャンセルしたり、再スケジュールしたりする機能も充実しており、管理画面からユーザーがジョブを制御するような複雑なアプリケーションに適しています。
cron is a robust tool for running jobs (functions or commands) on schedules defined using the cron syntax.
Perfect for tasks like data backups, notifications, and many more!
child_processnpm install cron
v4 dropped Node v16 and renamed the job.running property:
Node v16 is no longer supported. Upgrade your Node installation to Node v18 or above
You can no longer set the running property (now isActive). It is read-only. To start or stop a cron job, use job.start() and job.stop().
v3 introduced TypeScript and tighter Unix cron pattern alignment:
Month Indexing: Changed from 0-11 to 1-12. So you need to increment all numeric months by 1.
Day-of-Week Indexing: Support added for 7 as Sunday.
CronJobCronJob.from(argsObject) instead.nextDates(count?: number) now always returns an array (empty if no argument is provided). Use nextDate() instead for a single date.removed job() method in favor of new CronJob(...args) / CronJob.from(argsObject)
removed time() method in favor of new CronTime()
import { CronJob } from 'cron';
const job = new CronJob(
'* * * * * *', // cronTime
function () {
console.log('You will see this message every second');
}, // onTick
null, // onComplete
true, // start
'America/Los_Angeles' // timeZone
);
// job.start() is optional here because of the fourth parameter set to true.
// equivalent job using the "from" static method, providing parameters as an object
const job = CronJob.from({
cronTime: '* * * * * *',
onTick: function () {
console.log('You will see this message every second');
},
start: true,
timeZone: 'America/Los_Angeles'
});
Note: In the first example above, the fourth parameter to
CronJob()starts the job automatically. If not provided or set to falsy, you must explicitly start the job usingjob.start().
For more advanced examples, check the examples directory.
Cron patterns are the backbone of this library. Familiarize yourself with the syntax:
- `*` Asterisks: Any value
- `1-3,5` Ranges: Ranges and individual values
- `*/2` Steps: Every two units
Detailed patterns and explanations are available at crontab.org. The examples in the link have five fields, and 1 minute as the finest granularity, but our cron scheduling supports an enhanced format with six fields, allowing for second-level precision. Tools like crontab.guru can help in constructing patterns but remember to account for the seconds field.
Here's a quick reference to the UNIX Cron format this library uses, plus an added second field:
field allowed values
----- --------------
second 0-59
minute 0-59
hour 0-23
day of month 1-31
month 1-12 (or names, see below)
day of week 0-7 (0 or 7 is Sunday, or use names)
Names can also be used for the 'month' and 'day of week' fields. Use the first three letters of the particular day or month (case does not matter). Ranges and lists of names are allowed.
Examples: "mon,wed,fri", "jan-mar".
sendAt: Indicates when a CronTime will execute (returns a Luxon DateTime object).
import * as cron from 'cron';
const dt = cron.sendAt('0 0 * * *');
console.log(`The job would run at: ${dt.toISO()}`);
timeout: Indicates the number of milliseconds in the future at which a CronTime will execute (returns a number).
import * as cron from 'cron';
const timeout = cron.timeout('0 0 * * *');
console.log(`The job would run in ${timeout}ms`);
validateCronExpression: Validates if a given cron expression is valid (returns an object with valid and error properties).
import * as cron from 'cron';
const validation = cron.validateCronExpression('0 0 * * *');
console.log(`Is the cron expression valid? ${validation.valid}`);
if (!validation.valid) {
console.error(`Validation error: ${validation.error}`);
}
constructor(cronTime, onTick, onComplete, start, timeZone, context, runOnInit, utcOffset, unrefTimeout, waitForCompletion, errorHandler, name, threshold):
cronTime: [REQUIRED] - The time to fire off your job. Can be cron syntax, a JS Date object or a Luxon DateTime object.
onTick: [REQUIRED] - Function to execute at the specified time. If an onComplete callback was provided, onTick will receive it as an argument.
onComplete: [OPTIONAL] - Invoked when the job is halted with job.stop(). It might also be triggered by onTick post its run.
start: [OPTIONAL] - Determines if the job should commence before constructor exit. Default is false.
timeZone: [OPTIONAL] - Sets the execution time zone. Default is local time. Check valid formats in the Luxon documentation.
context: [OPTIONAL] - Execution context for the onTick method.
runOnInit: [OPTIONAL] - Instantly triggers the onTick function post initialization. Default is false.
utcOffset: [OPTIONAL] - Specifies time zone offset in minutes. Cannot co-exist with timeZone.
unrefTimeout: [OPTIONAL] - Useful for controlling event loop behavior. More details here.
waitForCompletion: [OPTIONAL] - If true, no additional instances of the onTick callback function will run until the current onTick callback has completed. Any new scheduled executions that occur while the current callback is running will be skipped entirely. Default is false.
errorHandler: [OPTIONAL] - Function to handle any exceptions that occur in the onTick method.
name: [OPTIONAL] - Name of the job. Useful for identifying jobs in logs.
threshold: [OPTIONAL] - Threshold in ms to control whether to execute or skip missed execution deadlines caused by slow or busy hardware. Execution delays within threshold will be executed immediately, and otherwise will be skipped. In both cases a warning will be printed to the console with the job name and cron expression. See issue #962 for more information. Default is 250.
from (static): Create a new CronJob object providing arguments as an object. See argument names and descriptions above.
start: Initiates the job.
stop: Halts the job.
setTime: Modifies the time for the CronJob. Parameter must be a CronTime.
lastDate: Provides the last execution date.
nextDate: Indicates the subsequent date that will activate an onTick.
nextDates(count): Supplies an array of upcoming dates that will initiate an onTick.
fireOnTick: Allows modification of the onTick calling behavior.
addCallback: Permits addition of onTick callbacks.
isActive: [READ-ONLY] Indicates if a job is active (checking to see if the callback needs to be called).
isCallbackRunning: [READ-ONLY] Indicates if a callback is currently executing.
const job = new CronJob('* * * * * *', async () => {
console.log(job.isCallbackRunning); // true during callback execution
await someAsyncTask();
console.log(job.isCallbackRunning); // still true until callback completes
});
console.log(job.isCallbackRunning); // false
job.start();
console.log(job.isActive); // true
console.log(job.isCallbackRunning); // false
constructor(time, zone, utcOffset):
time: [REQUIRED] - The time to initiate your job. Accepts cron syntax or a JS Date object.
zone: [OPTIONAL] - Equivalent to timeZone from CronJob parameters.
utcOffset: [OPTIONAL] - Analogous to utcOffset from CronJob parameters.
Both JS Date and Luxon DateTime objects don't guarantee millisecond precision due to computation delays. This module excludes millisecond precision for standard cron syntax but allows execution date specification through JS Date or Luxon DateTime objects. However, specifying a precise future execution time, such as adding a millisecond to the current time, may not always work due to these computation delays. It's observed that delays less than 4-5 ms might lead to inconsistencies. While we could limit all date granularity to seconds, we've chosen to allow greater precision but advise users of potential issues.
Using arrow functions for onTick binds them to the parent's this context. As a result, they won't have access to the cronjob's this context. You can read a little more in issue #47 (comment).
Join the Discord server! Here you can discuss issues and get help in a more casual forum than GitHub.
This project is looking for help! If you're interested in helping with the project, please take a look at our contributing documentation.
Please have a look at our contributing documentation, it contains all the information you need to know before submitting an issue.
This is a community effort project. In the truest sense, this project started as an open source project from cron.js and grew into something else. Other people have contributed code, time, and oversight to the project. At this point there are too many to name here so we'll just say thanks.
Special thanks to Hiroki Horiuchi, Lundarl Gholoi and koooge for their work on the DefinitelyTyped typings before they were imported in v2.4.0.
MIT