A simple Node.js utility for parsing schedule strings, and finding the next scheduled event time.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
LICENSE.MIT
README.md
package.json

README.md

schyntax

npm version Build Status Supported Schyntax Version: 1.0.1

A simple Node.js utility for parsing Schyntax schedule strings, and finding the next scheduled event time.

Schyntax is not a scheduled task runner. It simply helps you determine when a task should run. If you're looking for a task runner built on Schyntax, try Schtick.

Install

npm install schyntax

Examples

Find the next weekday (Monday through Friday) at 16:00 UTC:

var schyntax = require('schyntax');

var schedule = schyntax('hours(16), days(mon..fri)');
console.log(schedule.next());

Find noon on the next day which isn't the Fourth of July or December 25th:

var schedule = schyntax('hours(12), dates(!12/25, !7/4)');
console.log(schedule.next());

Find the next seven dates which are either 10AM on a weekday, or noon on a weekend by using schedule groups (expressions grouped inside curly braces):

var schedule = schyntax('{hours(10), days(!sat..sun)} {hours(12), days(sat..sun)}');
var dates = [];
var d = null;
for (var i = 0; i < 7; i++) {
  d = schedule.next(d);
  dates.push(d);
}
console.log(dates);

Methods

schyntax#next

Accepts an optional after argument in the form of a Date object or numeric Unix timestamp in milliseconds. If no argument is provided, the current time is used.

Returns a Date object representing the next timestamp which matches the scheduling criteria. The date will always be greater than, never equal to, after. If no timestamp could be found which matches the scheduling criteria, a ValidTimeNotFoundError error is thrown, which generally indicates conflicting scheduling criteria (explicitly including and excluding the same day or time).

schyntax#previous

Same as schyntax#next accept that its return value will be less than or equal to the current time or optional atOrBefore argument. This means that if you want to find the last n-previous events, you should subtract at least a millisecond from the result before passing it back to the function. For example, here is the reverse of one of the prior examples:

var schedule = schyntax('{ hours(10), days(!sat..sun) } { hours(12), days(sat..sun) }');
var dates = [];
var d = null;
for (var i = 0; i < 7; i++) {
  d = schedule.previous(d ? d - 1 : null);
  dates.push(d);
}
console.log(dates);

Syntax

For complete documentation on the Schyntax domain-specific language, see the Schyntax project.