https://github.com/node-cron/node-cron
A simple cron-like job scheduler for Node.js
https://github.com/node-cron/node-cron
cron cron-syntax node-cron scheduled-jobs scheduled-tasks
Last synced: about 1 month ago
JSON representation
A simple cron-like job scheduler for Node.js
- Host: GitHub
- URL: https://github.com/node-cron/node-cron
- Owner: node-cron
- License: isc
- Created: 2016-02-03T17:55:47.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2025-05-10T14:02:35.000Z (about 1 month ago)
- Last Synced: 2025-05-10T14:16:48.876Z (about 1 month ago)
- Topics: cron, cron-syntax, node-cron, scheduled-jobs, scheduled-tasks
- Language: TypeScript
- Homepage:
- Size: 659 KB
- Stars: 3,046
- Watchers: 22
- Forks: 258
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome - node-cron/node-cron - A simple cron-like job scheduler for Node.js (TypeScript)
- awesome - node-cron - like job scheduler for Node.js (Node.js)
- awesome-made-by-brazilians - Node Cron
README
# Node Cron
[](https://github.com/merencia/node-cron/blob/master/LICENSE.md)
[](https://img.shields.io/npm/v/node-cron.svg)
[](https://coveralls.io/github/node-cron/node-cron?branch=main)
The node-cron module is tiny task scheduler in pure JavaScript for node.js based on [GNU crontab](https://www.gnu.org/software/mcron/manual/html_node/Crontab-file.html). This module allows you to schedule task in node.js using full crontab syntax.
### [Node-Cron Documentation](http://nodecron.com)
## Getting Started
Install node-cron using npm:
```console
npm install --save node-cron
```
Import node-cron and schedule a task:
- commonjs
```javascript
const cron = require('node-cron');
cron.schedule('* * * * *', () => {
console.log('running a task every minute');
});
```
- es6 (module)
```javascript
import cron from 'node-cron';
cron.schedule('* * * * *', () => {
console.log('running a task every minute');
});
```
## Cron Syntax
This is a quick reference to cron syntax and also shows the options supported by node-cron.
### Allowed fields
```
# ┌────────────── second (optional)
# │ ┌──────────── minute
# │ │ ┌────────── hour
# │ │ │ ┌──────── day of month
# │ │ │ │ ┌────── month
# │ │ │ │ │ ┌──── day of week
# │ │ │ │ │ │
# │ │ │ │ │ │
# * * * * * *
```
### Allowed values
| field | value |
| ------------ | --------------------------------- |
| second | 0-59 |
| minute | 0-59 |
| hour | 0-23 |
| day of month | 1-31 |
| month | 1-12 (or names) |
| day of week | 0-7 (or names, 0 or 7 are sunday) |
## Issues
Feel free to submit issues and enhancement requests [here](https://github.com/merencia/node-cron/issues).
## 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.
## Contributors
This project exists thanks to all the people who contribute.
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/node-cron#backer)]
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/node-cron#sponsor)]
## License
node-cron is under [ISC License](https://github.com/merencia/node-cron/blob/master/LICENSE.md).