https://github.com/fwd/cron
A NodeJS wrapper around setInterval for expressive cron like repetitive tasks.
https://github.com/fwd/cron
api cron cronjob javascript nodejs nodejs-wrapper repetitive-tasks serverless setinterval
Last synced: 3 months ago
JSON representation
A NodeJS wrapper around setInterval for expressive cron like repetitive tasks.
- Host: GitHub
- URL: https://github.com/fwd/cron
- Owner: fwd
- Created: 2020-08-25T18:09:00.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-25T18:18:19.000Z (about 4 years ago)
- Last Synced: 2024-04-23T13:17:35.956Z (about 1 year ago)
- Topics: api, cron, cronjob, javascript, nodejs, nodejs-wrapper, repetitive-tasks, serverless, setinterval
- Language: JavaScript
- Homepage:
- Size: 10.4 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
@fwd/cron 💾
> A NodeJS package to simplify runtime CRON jobs. A sexier setInterval, basically.
## Install
```sh
npm install fwd/cron
```
## Usage
```js
const cron = require('@fwd/cron')
cron(() => {
// runs every 24 hours
}, 'every 24 hours')
cron(() => {
// runs every 1 month, and immediately once
}, 'every 1 month', true)
```
## Parameters
```js
cron(function, interval, runImmediately)
````
## Available Intervals
- second(s)
- minute(s)
- hour(s)
- month(s)
- year(s)
This package uses [@fwd/time](https://github.com/fwd/time) to parse time intervals.
## 👤 Author
* Github: [@fwd](https://github.com/fwd)
* Website: [https://forward.miami](https://forward.miami)
## 🤝 Contributing
Give a ⭐️ if this project helped you!
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/fwd/cron/issues).
## 📝 License
MIT License
Copyright © 2021 [Forward Miami](https://forward.miami).
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.