Fantastisches Community-Modul

Knoten Cron

npm npm Abdeckungsstatus Code Klima Build-Status Abhängigkeitsstatus devDependency Status

Das Node-Cron-Modul ist ein winziger Taskplaner in reinem JavaScript für node.js, der auf GNU crontab basiert. Mit diesem Modul können Sie Task in node.js mit der vollständigen Crontab-Syntax planen.

NPM

Erste Schritte

Installieren Sie node-cron mit npm:

1
$ npm install --save node-cron

Importieren Sie Node-Cron und planen Sie eine Aufgabe:

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

Cron-Syntax

Dies ist eine Kurzreferenz zur Cron-Syntax und zeigt auch die von Node-Cron unterstützten Optionen.

Allowed fields

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

Allowed values

Feld Wert
zweitens 0-59
Minute 0-59
Stunde 0-23
Tag des Monats 1-31
Monat 1-12 (oder Namen)
Wochentag 0-7 (oder Namen, 0 oder 7 sind Sonntag)

Mehrfachwerte verwenden

Sie können mehrere durch Komma getrennte Werte verwenden:

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'); });

Bereiche verwenden

Sie können auch einen Wertebereich definieren:

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

Schrittwerte verwenden

Schrittwerte können in Verbindung mit Bereichen verwendet werden, die einem Bereich mit '/' und einer Zahl folgen. Beispiel: 1-10/2 , was 2,4,6,8,10 . Schritte sind auch nach einem Sternchen zulässig Wenn Sie also "alle zwei Minuten" sagen möchten, verwenden Sie einfach */2 .

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

Namen verwenden

Für Monat und Woche können Sie auch Namen oder Kurznamen verwenden. ZB:

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'); });

Oder mit Kurznamen:

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-Methoden

Schedule

Plant die Ausführung einer bestimmten Aufgabe, wenn der Cron-Ausdruck aktiviert ist.

Argumente:

  • ! string expression-Cron Ausdruck
  • ! Funktion func-Task ausgeführt werden
  • boolean? instantStart-Gibt an, ob der Scheduler unmittelbar nach dem Erstellen gestartet werden soll.

ScheduledTask-Methoden

Start

Startet die geplante Aufgabe.

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

Die Aufgabe wird erst ausgeführt, wenn sie neu gestartet wurde.

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

Die Aufgabe wird gestoppt und vollständig zerstört.

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

Überprüfen Sie, ob die angegebene Zeichenfolge ein gültiger Cron-Ausdruck ist.

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

Probleme

Und Delinquenz und das Senden als frei zu fühlen Enhancement Requests hier Tapete .

Mitwirkende

Im Allgemeinen folgen wir dem Git-Workflow "Fork-and-Pull".

  • Fork das Repo auf GitHub;
  • Übernehmen Sie Änderungen an einem Zweig in Ihrer Gabel.
  • Pull-Anfrage "Upstream" mit Ihren Änderungen;

HINWEIS: Stellen Sie sicher, dass Sie das Neueste aus "Upstream" zusammenführen, bevor Sie eine Pull-Anfrage stellen!

Bitte tragen Sie keinen Code bei, den Sie nicht selbst geschrieben haben, es sei denn, Sie sind sicher, dass Sie dazu rechtlich berechtigt sind. Stellen Sie außerdem sicher, dass der gesamte eingebrachte Code unter der ISC-Lizenz verteilt werden kann.

Lizenz

node-cron steht unter der ISC License .