Skip to content

kbariotis/node-cron-expression

Repository files navigation

node-cron-expression

npm npm

Declarative functional cron expression builder. Use it with tools like node-cron or bull

Screenshot of node-cron-expression

Getting Started

Install node-cron-expression using npm:

$ npm install --save node-cron-expression

Import node-cron-expression and build an expression

const { onDayOfTheWeek, every, everyHour } = require('node-cron-expression');

console.log(onDayOfTheWeek(6).toString()); // 0 0 * * 6
console.log(everyHour().toString()); // 0 * * * *
console.log(every(8).hours().toString()); // 0 */8 * * *

Documentation

Find all available methods with examples here.

Issues

Feel free to submit issues and enhancement requests here.

Contributing

In general, we follow the "fork-and-pull" Git workflow.

  • Fork the repo on GitHub;
  • Commit changes to a branch in your fork;
  • Pull request "upstream" with your changes;

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Please do not contribute code you did not write yourself, unless you are certain you have the legal ability to do so. Also ensure all contributed code can be distributed under the ISC License.

License

node-cron-expression is under MIT License.