Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hiddentao/cron-async
Execute something on a schedule, using cron syntax, with async/await support.
https://github.com/hiddentao/cron-async
async await cron javascript job promise schedule scheduler task typescript
Last synced: 8 days ago
JSON representation
Execute something on a schedule, using cron syntax, with async/await support.
- Host: GitHub
- URL: https://github.com/hiddentao/cron-async
- Owner: hiddentao
- License: mit
- Created: 2023-07-20T16:31:52.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-11T04:41:32.000Z (about 2 months ago)
- Last Synced: 2024-10-23T10:02:40.586Z (16 days ago)
- Topics: async, await, cron, javascript, job, promise, schedule, scheduler, task, typescript
- Language: TypeScript
- Homepage: https://hiddentao.github.io/cron-async
- Size: 192 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://badge.fury.io/js/cron-async)
[](https://twitter.com/hiddentao)
# cron-async
Javascript library for executing tasks on a schedule, using cron syntax, with async/await support. It is inspired by [node-cron](https://www.npmjs.com/package/cron).
It's smart at handling async jobs. All executions are wrapped in a `try-catch` clause and errors are caught and logged. It also waits until the current iteration of
a job has finished executing before starting the next iteration, regardless of the job's schedule.
Features:
* Works in both Node.js and Browsers.
* Performant: uses a single interval timer for all created jobs.
* Customizable logger.
* Typesript support / fully typed.
* Auto-generated [API documentation](https://hiddentao.github.io/cron-async).
## Installation
* NPM: `npm i cron-async`
* Yarn: `yarn add cron-async`
* PNPM: `pnpm add cron-async`
## Usage
First create a `Cron` instance:
```js
import { Cron } from 'cron-async'
const cron = new Cron()
```
Now add a job:
```js
cron.createJob('job1', {
cron: "*/1 * * * * *", // every second
onTick: async () => {
// do stuff in here on every iteration
},
})
```
The above job will run automatically every second. You can start and stop the job at any time:
```js
cron.getJob('job1').stop() // stop the job
// ...
cron.getJob('job1').start() // resume the job
```
You can also delete the job from the cron instance entirely in two ways:
```js
// the following statements do the same thing...
cron.deleteJob('job1')
cron.getJob('job1').destroy()
```
By defualt, the logger is the built-in `console` object. You can customize this by overriding the `log` config option:
```js
cron.createJob('job1', {
cron: "*/1 * * * * *", // every second
onTick: async () => { /* do stuff */ },
log: {
trace: (msg) => { /* do something */ },
debug: (msg) => { /* do something */ },
error: (msg) => { /* do something */ },
}
})
```
You can also specify the job to NOT automatically run when created:
```js
cron.createJob('job1', {
cron: "*/1 * * * * *", // every second
onTick: async () => { /* do stuff */ },
dontAutoRun: true,
})
// later on, we can start the job
cron.getJob('job1').start()
```
Each job keeps track of the number of iterations it has run:
```js
cron.createJob('job1', {
cron: "*/1 * * * * *", // every second
onTick: async () => { /* do stuff */ },
dontAutoRun: true,
})
// after some time....
const n = cron.getJob('job1').getNumIterations()
console.log( `Job has run ${n} times` )
```
The `onTick()` function you provide is automatically wrapped in a `try-catch` clause by the scheduler. If you wish to process any thrown errors you can supply an `onError` handler:
```js
cron.createJob('job1', {
cron: "*/1 * * * * *", // every second
onTick: async () => { /* do stuff */ },
onError: (err: Error) => {
// do something with the error
}
})
```
Finally, you can shutdown the `Cron` instance and its internal timer at any point using:
```js
cron.shutdown()
```
For other available methods and properties please see the [API documentation](https://hiddentao.github.io/cron-async).
## Developer guide
To build both ESM and CommonJS output:
```shell
pnpm build
```
To re-build the CommonJS output on chnage:
```shell
pnpm dev
```
To test:
```shell
pnpm test
```
To build the docs:
```shell
pnpm build-docs
```
To publish a new release (this will create a tag, publish to NPM and publish the latest docs):
```shell
pnpm release
```
## License
Copyright (C) 2023 [Ramesh Nair](https://hiddentao.com)
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 (including the next paragraph) 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.