Run scheduled tasks with Steve Jobs, the simple jobs queue made just for Meteor. With tight MongoDB integration and fibers-based timing functions, this package is quick, reliable and effortless to use.
- Jobs run on one server at a time
- Jobs run predictably and consecutively
- Jobs, their history and returned data are stored in MongoDB
- Failed jobs are retried on server restart
- No third party dependencies
The new 4.0 features repeating jobs, async support and more! It can run hundreds of jobs in seconds with minimal CPU impact, making it a reasonable choice for many applications. To get started, check out the documentation and the quick start below.
In addition to a simple API, the Steve Jobs package offers an in-app development tool. After installing the main package, run the package command below and press Control + J in your app to open it.
meteor add msavin:sjobs-ui-blaze
Note: this package may be a little bit flakey, and might not work if audit-argument-checks is present. Unfortunately, I had lost the source code, and will probably rebuild the package once there is a good reason to do so.
First, install the package, and import if necessary:
meteor add msavin:sjobsimport { Jobs } from 'meteor/msavin:sjobs'Then, write your background jobs like you would write your methods:
Jobs.register({
"sendReminder": function (to, message) {
const instance = this;
const call = HTTP.put("http://www.magic.com/email/send", {
to: to,
message: message,
subject: "You've Got Mail!",
})
if (call.statusCode !== 200) {
instance.reschedule({
in: {
minutes: 5
}
});
} else {
return call.data;
}
}
});Finally, schedule a background job like you would call a method:
Jobs.run("sendReminder", "[email protected]", "The future is here!");One more thing: the function above will schedule the job to run on the moment that the function was called, however, you can delay it by passing in a special configuration object at the end:
Jobs.run("sendReminder", "[email protected]", "The future is here!", {
in: {
days: 3,
},
on: {
hour: 9,
minute: 42
},
priority: 9999999999
});The configuration object supports date, in, on, priority, singular, unique, and data, all of which are completely optional. For more information, see the Jobs.run documentation.
Compared to a CRON Job, the Steve Jobs package gives you much more control over how and when the job runs. To get started, you just need to create a job that replicates itself.
Jobs.register({
"syncData": function () {
const instance = this;
const call = HTTP.put("http://www.magic.com/syncData")
if (call.statusCode === 200) {
instance.replicate({
in: {
hours: 1
}
});
// to save storage, you can remove the document
instance.remove();
} else {
instance.reschedule({
in: {
minutes: 5
}
});
}
}
});Then, you need to "kickstart" the queue by creating the first job to run. By using the singular flag, you can ensure that Meteor will only create the job if there is no pending or failed instance of it.
Meteor.startup(function () {
Jobs.run("syncData", {
singular: true
})
})Jobs.register and Jobs.run are all you need to get started, but that's only the beginning of what the package can do. To explore the rest of the functionality, jump into the documentation:
- Jobs.configure
- Jobs.register
- Jobs.run
- Jobs.execute
- Jobs.reschedule
- Jobs.replicate
- Jobs.start
- Jobs.stop
- Jobs.get
- Jobs.cancel
- Jobs.clear
- Jobs.remove
- Jobs.collection
Steve Jobs is an MIT-licensed project, brought to you by Meteor Candy.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent