isCancelledJob

function isCancelledJob<T>(job): boolean;

Defined in: packages/core/src/jobs/guards.ts:189

Type guard to check if a job has been manually cancelled.

A convenience helper for checking if a job was cancelled by an operator. Equivalent to job.status === JobStatus.CANCELLED but with better semantics.

Type Parameters

Type Parameter	Description
T	The type of the job’s data payload

Parameters

Parameter	Type	Description
job	Job<T>	The job to check

Returns

boolean

true if the job status is 'cancelled'

Example

const jobs = await monque.getJobs();
const cancelledJobs = jobs.filter(isCancelledJob);
console.log(`${cancelledJobs.length} jobs were cancelled`);