InspectableJobQueueStrategy

Defines a job queue strategy that can be inspected using the default admin ui

Signature

interface InspectableJobQueueStrategy extends JobQueueStrategy {    findOne(id: ID): Promise<Job | undefined>;    findMany(options?: JobListOptions): Promise<PaginatedList<Job>>;    findManyById(ids: ID[]): Promise<Job[]>;    removeSettledJobs(queueNames?: string[], olderThan?: Date): Promise<number>;    cancelJob(jobId: ID): Promise<Job | undefined>;    readonly useEntityIdStrategyForJobIds?: boolean;}

Extends: JobQueueStrategy

findOne

method(id: ID) => Promise<Job | undefined>

Returns a job by its id.

findMany

method(options?: JobListOptions) => Promise<PaginatedList<Job>>

Returns a list of jobs according to the specified options.

findManyById

method(ids: ID[]) => Promise<Job[]>

Returns an array of jobs for the given ids.

removeSettledJobs

method(queueNames?: string[], olderThan?: Date) => Promise<number>

Remove all settled jobs in the specified queues older than the given date. If no queueName is passed, all queues will be considered. If no olderThan date is passed, all jobs older than the current time will be removed.

Returns a promise of the number of jobs removed.

cancelJob

method(jobId: ID) => Promise<Job | undefined>

useEntityIdStrategyForJobIds

propertybooleanv3.8.1

Default:true

Whether the Admin API encodes and decodes job ids with the configured EntityIdStrategy. This is correct when job ids are database primary keys, as with the SqlJobQueueStrategy.

Set this to false if the job ids are generated by the job queue itself, as with the BullMQJobQueueStrategy. The ids are then passed through the Admin API unchanged. Otherwise an id which the EntityIdStrategy cannot decode, such as a UUID with the default AutoIncrementIdStrategy, cannot be used to look up the job.