Return all workers and what job they might be working on. Will throw an error if redis cannot be reached.
If a worker process crashes, it will leave its state in redis as "working". You can remove workers from redis you know to be over, by specificizing an age which would make them too old to exist. This method will remove the data created by a 'stuck' worker and move the payload to the error queue. However, it will not actually remove any processes which may be running. A job may be running that you have removed. Will throw an error if redis cannot be reached.
Delete a previously enqueued task, which hasn't been run yet, from a queue. Will throw an error if redis cannot be reached.
Inputs:
api.tasks.queued or similar method.Inputs:
Delete all previously enqueued tasks, which haven't been run yet, from all possible delayed timestamps. Will throw an error if redis cannot be reached.
Inputs:
api.tasks.delayedAt or similar method.Delete a lock on a job or worker. Locks can be found via api.tasks.locks
Will throw an error if redis cannot be reached.
Delete a queue in redis, and all jobs stored on it. Will throw an error if redis cannot be reached.
Return all jobs which have been enqueued to run at a certain timestamp. Will throw an error if redis cannot be reached.
Return wholistic details about the task system, including failures, queues, and workers. Will throw an error if redis cannot be reached.
Enqueue a task to be performed in the background. Will throw an error if redis cannot be reached.
This is run automatically at boot for all tasks which have a frequency, calling api.tasks.enqueueRecurrentTask
Will throw an error if redis cannot be reached.
Enqueue a task to be performed in the background, at a certain time in the future. Will throw an error if redis cannot be reached.
Inputs:
Enqueue a task to be performed in the background, at a certain number of ms from now. Will throw an error if redis cannot be reached.
Inputs:
Ensures that a task which has a frequency is either running, or already enqueued.
This is run automatically at boot for all tasks which have a frequency, via api.tasks.enqueueAllRecurrentTasks.
Will throw an error if redis cannot be reached.
Retrieve the details of failed jobs between start and stop (0-indexed). Will throw an error if redis cannot be reached.
How many jobs are in the failed queue. Will throw an error if redis cannot be reached.
Return any locks, as created by resque plugins or task middleware, in this redis namespace.
Will contain locks with keys like resque:lock:{job} and resque:workerslock:{workerId}
Will throw an error if redis cannot be reached.
Retrieve the details of jobs enqueued on a certain queue between start and stop (0-indexed) Will throw an error if redis cannot be reached.
Inputs:
Remove a specific job from the failed queue. Will throw an error if redis cannot be reached.
Remove a specific job from the failed queue, and retry it by placing it back into its original queue. Will throw an error if redis cannot be reached.
Return the timestamps a task is scheduled for. Will throw an error if redis cannot be reached.
Inputs:
api.tasks.delayedAt or similar method.Return all resque stats for this namespace (how jobs failed, jobs succeeded, etc) Will throw an error if redis cannot be reached.
Stop a task with a frequency by removing it from all possible queues. Will throw an error if redis cannot be reached.
List all timestamps for which tasks are enqueued in the future, via api.tasks.enqueueIn or api.tasks.enqueueAt
Will throw an error if redis cannot be reached.
Return all workers registered by all members of this cluster. Note: MultiWorker processors each register as a unique worker. Will throw an error if redis cannot be reached.
What is a given worker working on? If the worker is idle, 'started' will be returned. Will throw an error if redis cannot be reached.
Generated using TypeDoc
Return all delayed jobs, organized by the timestamp at where they are to run at. Note: This is a very slow command. Will throw an error if redis cannot be reached.