GetJobsFilter

Defined in: packages/core/src/jobs/types.ts:191

Filter options for querying jobs.

Use with monque.getJobs() to filter jobs by name, status, or limit results.

Example

// Get all pending email jobs
const pendingEmails = await monque.getJobs({
  name: 'send-email',
  status: JobStatus.PENDING,
});

// Get all failed or completed jobs (paginated)
const finishedJobs = await monque.getJobs({
  status: [JobStatus.COMPLETED, JobStatus.FAILED],
  limit: 50,
  skip: 100,
});

Properties

limit?

optional limit: number;

Defined in: packages/core/src/jobs/types.ts:199

Maximum number of jobs to return (default: 100)

---

name?

optional name: string;

Defined in: packages/core/src/jobs/types.ts:193

Filter by job type name

---

skip?

optional skip: number;

Defined in: packages/core/src/jobs/types.ts:202

Number of jobs to skip for pagination

---

status?

optional status: 
  | JobStatusType
  | JobStatusType[];

Defined in: packages/core/src/jobs/types.ts:196

Filter by status (single or multiple)