@bugslifesolutions/api-plugin-bull-queue
v0.1.0-next.12
Published
Job Queue plugin for the Reaction API based on BullMQ
Downloads
15
Readme
api-plugin-bull-queue
[](https://www.npmjs. com/package/@reactioncommerce/api-plugin-bull-queue) [](https://circleci. com/gh/reactioncommerce/api-plugin-bull-queue)
Summary
Job Queue plugin Based on Bull for the Reaction API
The current API includes just 4 commands:
createQueue
- Which creates a job queue, assigns a processor to it and adds the queue to the context to it's
accessible everywhere
addJob
- Allows you to add a job to the queue. You can see an example of this in the include email plugin
scheduleJob
- Allows you to schedule repeating job using cron syntax. You can see an example of
this in the Promotions plugin.
addDelayedJob
- Similar to addJob
but just allows you to delay the job by a number of ms.
Many more commands are available if you have an instance of the queue
Developer Certificate of Origin
We use the Developer Certificate of Origin (DCO) in lieu of a Contributor License Agreement for all contributions to Reaction Commerce open source projects. We request that contributors agree to the terms of the DCO and indicate that agreement by signing all commits made to Reaction Commerce projects by adding a line with your name and email address to every Git commit message contributed:
Signed-off-by: Jane Doe <[email protected]>
You can sign your commit automatically with Git by using git commit -s
if you have your user.name
and user.email
set as part of your Git configuration.
We ask that you use your real name (please no anonymous contributions or pseudonyms). By signing your commit you are certifying that you have the right have the right to submit it under the open source license used by that particular Reaction Commerce project. You must use your real name (no pseudonyms or anonymous contributions are allowed.)
We use the Probot DCO GitHub app to check for DCO signoffs of every commit.
If you forget to sign your commits, the DCO bot will remind you and give you detailed instructions for how to amend your commits to add a signature.
License
Copyright 2022 Reaction Commerce
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.