Optionalopts: QueueProOptionsOptionalopts: JobsProOptionsAdds an array of jobs to the queue. This method may be faster than adding one job at a time in a sequence.
The array of jobs to add to the queue. Each job is defined by 3 properties, 'name', 'data' and 'opts'. They follow the same signature as 'Queue.add'.
Cleans all the jobs that are part of a group.
Cleans all the groups in this queue
Get jobs that are part of a given group.
Gets the count of jobs inside a given group id.
Get the group ids with jobs current jobs in them.
TODO: Support group id filtering.
Gets all the groups that are in a particular status.
GroupStatus so we can filter by status
start index, used for pagination.
end index, used for pagination.
an array of objects with the group id and status.
Get the total number of groups with jobs in them.
Gets the count of all the jobs belonging to any group.
Get the given group status.
The group id to get the status for.
GroupStatus - The status of the group or null if the group does not exist.
Get library version.
the content of the meta.library field.
Completely destroys the queue and all of its contents irreversibly. This method will the pause the queue and requires that there are no active jobs. It is possible to bypass this requirement, i.e. not having active jobs using the "force" option.
Note: This operation requires to iterate on all the jobs stored in the queue and can be slow for very large queues.
Optionalopts: { count?: number; force?: boolean }Obliterate options.
Pauses the processing of a specific group globally.
Adding jobs requires a LUA script to check first if the paused list exist and in that case it will add it there instead of the wait list or group list.
Repairs a maxed group.
It seems that in some unknown situations a group can become maxed although there are no active jobs in the group. This function will try to repair this situation.
the group to repair
Resumes the processing of a specific group globally.
The method reverses the pause operation by resuming the processing of the group.
the group to resume
Adds a Job to the queue.