素晴らしいコミュニティモジュール

ノードクロン

npm npm 取材状況 コード気候 ビルドステータス 依存関係ステータス devDependency ステータス

node-cron モジュールは、GNU crontab に基づいた node.js 用の純粋な JavaScript の小さなタスク スケジューラです。このモジュールを使用すると、完全な crontab 構文を使用して、node.js でタスクをスケジュールできます。

NPM

入門

npm を使用して node-cron をインストールします。

1
$ npm install --save node-cron

node-cron をインポートしてタスクをスケジュールします。

1 2 3 4 5
var cron = require('node-cron'); cron.schedule('* * * * *', function(){ console.log('running a task every minute'); });

cron 構文

これは cron 構文のクイック リファレンスであり、node-cron でサポートされるオプションも示しています。

Allowed fields

1 2 3 4 5 6 7 8 9
# ┌────────────── second (optional) # │ ┌──────────── minute # │ │ ┌────────── hour # │ │ │ ┌──────── day of month # │ │ │ │ ┌────── month # │ │ │ │ │ ┌──── day of week # │ │ │ │ │ │ # │ │ │ │ │ │ # * * * * * *

Allowed values

フィールド
0~59
0~59
時間 0~23
1-31
1-12 (または名前)
曜日 0-7 (または名前、0 または 7 は日曜日)

複数の値の使用

コンマで区切られた複数の値を使用できます:

1 2 3 4 5
var cron = require('node-cron'); cron.schedule('1,2,4,5 * * * *', function(){ console.log('running every minute 1, 2, 4 and 5'); });

範囲の使用

値の範囲を定義することもできます。

1 2 3 4 5
var cron = require('node-cron'); cron.schedule('1-5 * * * *', function(){ console.log('running every minute to 1 from 5'); });

ステップ値の使用

ステップ値は、範囲と組み合わせて使用​​でき、「/」と数字で範囲を指定します。例:1-10/2これは と同じ2,4,6,8,10です。ステップはアスタリスクの後にも許可されます。したがって、「2 分ごと」と言いたい場合、そのままお使いください*/2

1 2 3 4 5
var cron = require('node-cron'); cron.schedule('*/2 * * * *', function(){ console.log('running a task every two minutes'); });

名前の使用

月と曜日には、名前または短い名前を使用することもできます。例:

1 2 3 4 5
var cron = require('node-cron'); cron.schedule('* * * January,September Sunday', function(){ console.log('running on Sundays of January and September'); });

または短い名前で:

1 2 3 4 5
var cron = require('node-cron'); cron.schedule('* * * Jan,Sep Sun', function(){ console.log('running on Sundays of January and September'); });

Cron メソッド

Schedule

cron 式がティックするたびに実行されるように指定されたタスクをスケジュールします。

引数:

  • !string 式 - Cron 式
  • !Function func-実行するタスク
  • boolean?immediateStart - 作成直後にスケジューラを開始するかどうか。

ScheduledTask メソッド

Start

スケジュールされたタスクを開始します。

1 2 3 4 5 6 7
var cron = require('node-cron'); var task = cron.schedule('* * * * *', function() { console.log('immediately started'); }, false); task.start();

Stop

再起動しないとタスクは実行されません。

1 2 3 4 5 6 7
var cron = require('node-cron'); var task = cron.schedule('* * * * *', function() { console.log('will execute every minute until stopped'); }); task.stop();

Destroy

タスクは停止され、完全に破壊されます。

1 2 3 4 5 6 7
var cron = require('node-cron'); var task = cron.schedule('* * * * *', function() { console.log('will not execute anymore, nor be able to restart'); }); task.destroy();

Validate

指定された文字列が有効な cron 式であることを検証します。

1 2 3 4
var cron = require('node-cron'); var valid = cron.validate('59 * * * *'); var invalid = cron.validate('60 * * * *');

問題

問題や機能強化のリクエストはこちらからお気軽に送信してください

貢献者

一般に、「フォークとプル」の Git ワークフローに従います。

  • GitHub でリポジトリをフォークします。
  • フォーク内のブランチへの変更をコミットします。
  • 変更を加えたプル リクエストの「アップストリーム」。

注: プルリクエストを行う前に、必ず「上流」から最新のものをマージしてください!

自分で書いたものではないコードを提供する法的能力があると確信している場合を除き、提供しないでください.また、提供されたすべてのコードが ISC ライセンスの下で配布できることを確認してください.

ライセンス

node-cron の下にある ISC License.