MonqueService

Defined in: tsed/src/services/monque-service.ts:45

Injectable service that wraps the Monque instance.

Exposes the full Monque public API through dependency injection.

Constructors

Constructor

new MonqueService(): MonqueService;

Returns

MonqueService

Accessors

monque

Get Signature

get monque(): Monque;

Defined in: tsed/src/services/monque-service.ts:65

Access the underlying Monque instance.

Throws

Error if MonqueModule is not initialized

Returns

Monque

Methods

cancelJob()

cancelJob(jobId): Promise<PersistedJob<unknown> | null>;

Defined in: tsed/src/services/monque-service.ts:130

Cancel a pending or scheduled job.

Parameters

Parameter	Type	Description
jobId	string	The ID of the job to cancel

Returns

Promise<PersistedJob<unknown> | null>

The cancelled job, or null if not found

---

cancelJobs()

cancelJobs(filter): Promise<BulkOperationResult>;

Defined in: tsed/src/services/monque-service.ts:175

Cancel multiple jobs matching the given filter.

Parameters

Parameter	Type	Description
filter	JobSelector	Selector for which jobs to cancel

Returns

Promise<BulkOperationResult>

Result with count of cancelled jobs

---

deleteJob()

deleteJob(jobId): Promise<boolean>;

Defined in: tsed/src/services/monque-service.ts:161

Permanently delete a job.

Parameters

Parameter	Type	Description
jobId	string	The ID of the job to delete

Returns

Promise<boolean>

true if deleted, false if job not found

---

deleteJobs()

deleteJobs(filter): Promise<BulkOperationResult>;

Defined in: tsed/src/services/monque-service.ts:195

Delete multiple jobs matching the given filter.

Parameters

Parameter	Type	Description
filter	JobSelector	Selector for which jobs to delete

Returns

Promise<BulkOperationResult>

Result with count of deleted jobs

---

enqueue()

enqueue<T>(
   name, 
   data, 
options?): Promise<PersistedJob<T>>;

Defined in: tsed/src/services/monque-service.ts:87

Enqueue a job for processing.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
name	string	Job type identifier (use full namespaced name, e.g., “email.send”)
data	T	Job payload
options?	EnqueueOptions	Scheduling and deduplication options

Returns

Promise<PersistedJob<T>>

The created or existing job document

---

getJob()

getJob<T>(jobId): Promise<PersistedJob<T> | null>;

Defined in: tsed/src/services/monque-service.ts:210

Get a job by its ID.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
jobId	string | ObjectId	The job’s ObjectId (as string or ObjectId)

Returns

Promise<PersistedJob<T> | null>

The job document, or null if not found

Throws

MonqueError if jobId is an invalid hex string

---

getJobs()

getJobs<T>(filter?): Promise<PersistedJob<T>[]>;

Defined in: tsed/src/services/monque-service.ts:231

Query jobs from the queue with optional filters.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
filter?	GetJobsFilter	Optional filter criteria (name, status, limit, skip)

Returns

Promise<PersistedJob<T>[]>

Array of matching jobs

---

getJobsWithCursor()

getJobsWithCursor<T>(options?): Promise<CursorPage<T>>;

Defined in: tsed/src/services/monque-service.ts:241

Get a paginated list of jobs using opaque cursors.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
options?	CursorOptions	Pagination options (cursor, limit, direction, filter)

Returns

Promise<CursorPage<T>>

Page of jobs with next/prev cursors

---

getQueueStats()

getQueueStats(filter?): Promise<QueueStats>;

Defined in: tsed/src/services/monque-service.ts:251

Get aggregate statistics for the job queue.

Parameters

Parameter	Type	Description
filter?	Pick<JobSelector, "name">	Optional filter to scope statistics by job name

Returns

Promise<QueueStats>

Queue statistics

---

isHealthy()

isHealthy(): boolean;

Defined in: tsed/src/services/monque-service.ts:264

Check if the scheduler is healthy and running.

Returns

boolean

true if running and connected

---

now()

now<T>(name, data): Promise<PersistedJob<T>>;

Defined in: tsed/src/services/monque-service.ts:98

Enqueue a job for immediate processing.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
name	string	Job type identifier
data	T	Job payload

Returns

Promise<PersistedJob<T>>

The created job document

---

rescheduleJob()

rescheduleJob(jobId, runAt): Promise<PersistedJob<unknown> | null>;

Defined in: tsed/src/services/monque-service.ts:151

Reschedule a pending job to run at a different time.

Parameters

Parameter	Type	Description
jobId	string	The ID of the job to reschedule
runAt	Date	The new Date when the job should run

Returns

Promise<PersistedJob<unknown> | null>

The updated job, or null if not found

---

retryJob()

retryJob(jobId): Promise<PersistedJob<unknown> | null>;

Defined in: tsed/src/services/monque-service.ts:140

Retry a failed or cancelled job.

Parameters

Parameter	Type	Description
jobId	string	The ID of the job to retry

Returns

Promise<PersistedJob<unknown> | null>

The updated job, or null if not found

---

retryJobs()

retryJobs(filter): Promise<BulkOperationResult>;

Defined in: tsed/src/services/monque-service.ts:185

Retry multiple jobs matching the given filter.

Parameters

Parameter	Type	Description
filter	JobSelector	Selector for which jobs to retry

Returns

Promise<BulkOperationResult>

Result with count of retried jobs

---

schedule()

schedule<T>(
   cron, 
   name, 
   data, 
options?): Promise<PersistedJob<T>>;

Defined in: tsed/src/services/monque-service.ts:111

Schedule a recurring job with a cron expression.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
cron	string	Cron expression (5-field standard or predefined like @daily)
name	string	Job type identifier
data	T	Job payload
options?	ScheduleOptions	Scheduling options

Returns

Promise<PersistedJob<T>>

The created job document