https://github.com/salakjs/salak-schedule
Timed task for salak.
https://github.com/salakjs/salak-schedule
Last synced: 11 months ago
JSON representation
Timed task for salak.
- Host: GitHub
- URL: https://github.com/salakjs/salak-schedule
- Owner: SalakJS
- License: mit
- Created: 2018-05-16T02:02:36.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2019-06-22T15:05:56.000Z (almost 7 years ago)
- Last Synced: 2025-05-23T07:41:35.674Z (about 1 year ago)
- Language: JavaScript
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# salak-schedule
[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![David deps][david-image]][david-url]
[![NPM download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/salak-schedule.svg?style=flat-square
[npm-url]: https://npmjs.org/package/salak-schedule
[travis-image]: https://img.shields.io/travis/SalakJS/salak-schedule.svg?style=flat-square
[travis-url]: https://travis-ci.org/SalakJS/salak-schedule
[david-image]: https://img.shields.io/david/SalakJS/salak-schedule.svg?style=flat-square
[david-url]: https://david-dm.org/SalakJS/salak-schedule
[download-image]: https://img.shields.io/npm/dm/salak-schedule.svg?style=flat-square
[download-url]: https://npmjs.org/package/salak-schedule
Cron task for salak.
## Feature
- Three mode: single、worker and all.
- `single` means the task will be trigger on the only one thread in the only one machine.
- `worker` means the task will be trigger on the only one thread in every machine.
- `all` means the task will be trigger on every thread
- Task can trigger service.
## Install
```
npm install --save salak-schedule
```
## Usage
```javascript
const schedule = require('salak-schedule')
schedule(options, app)
```
load schedule from dir `schedule` under every module.
```javascript
const { Service } = require('salak')
class Task extends Service {
static timer () {
return {
enable: true, // default true
interval: 1000,
type: 'all', // single、all、worker, default 'all'
cron: '* * * * * *', // use `cron-parser`
cronOptions: {}
}
}
async run () { // for the task logic
}
}
```
## API
### schedule options
- Store: for `single` or `worker`，default redisStore
- prefix: for `single` or `worker`，default 'salakTimer'
- options: options for Store. default app.redis
### app.getSchedules()
### app.runSchedule(key)
- key: `${module}.${taskfilename}`
### app.closeSchedules()
## Write a store
```javascript
class AStore {
lock (key, ttl) {}
unlock (lock) {}
}
module.exports = AStore
```
## License
MIT