Job

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

Represents a job in the Monque queue.

Example

interface EmailJobData {
  to: string;
  subject: string;
  template: string;
}

const job: Job<EmailJobData> = {
  name: 'send-email',
  data: { to: 'user@example.com', subject: 'Welcome!', template: 'welcome' },
  status: JobStatus.PENDING,
  nextRunAt: new Date(),
  failCount: 0,
  createdAt: new Date(),
  updatedAt: new Date(),
};

Type Parameters

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

Properties

_id?

optional _id: ObjectId;

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

MongoDB document identifier

claimedBy?

optional claimedBy: string | null;

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

Unique identifier of the scheduler instance that claimed this job. Used for atomic claim pattern - ensures only one instance processes each job. Set when a job is claimed, cleared when job completes or fails.

createdAt

createdAt: Date;

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

Job creation timestamp

data

data: T;

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

Job payload - must be JSON-serializable

failCount

failCount: number;

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

Number of failed attempts

failReason?

optional failReason: string;

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

Last failure error message

heartbeatInterval?

optional heartbeatInterval: number;

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

Heartbeat interval in milliseconds for this job. Stored on the job to allow recovery logic to use the correct timeout.

lastHeartbeat?

optional lastHeartbeat: Date | null;

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

Timestamp of the last heartbeat update for this job. Used to detect stale jobs when a scheduler instance crashes without releasing. Updated periodically while job is being processed.