MonqueService

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

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:71

Access the underlying Monque instance.

Throws

if MonqueModule is not initialized

Returns

Monque

Methods

cancelJob()

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

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

Cancel a pending or scheduled job.

Parameters

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

Returns

Promise<PersistedJob | null>

The cancelled job, or null if not found

---

cancelJobs()

cancelJobs(filter): Promise<BulkOperationResult>;

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

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:186

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:220

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:93

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

---

enqueueMany()

enqueueMany(jobs, options?): Promise<EnqueueManyResult>;

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

Enqueue a batch using full namespaced job names and per-job scheduling options.

Parameters

Parameter	Type
jobs	readonly EnqueueJob<unknown>[]
options?	JobWriteOptions

Returns

Promise<EnqueueManyResult>

---

getJob()

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

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

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

if jobId is an invalid hex string

---

getJobs()

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

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

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:267

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

---

getProcessingState()

getProcessingState(name?): ProcessingState;

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

Identify and inspect the local scheduler’s global or named-worker pause state.

Parameters

Parameter	Type
name?	string

Returns

ProcessingState

---

getQueueStats()

getQueueStats(filter?): Promise<QueueStats>;

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

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

---

getQueueViewSummaries()

getQueueViewSummaries(filter?): Promise<readonly QueueViewSummary[]>;

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

Read persisted queue counts and fresh local worker policies.

Parameters

Parameter	Type
filter?	Pick<JobSelector, "name">

Returns

Promise<readonly QueueViewSummary[]>

---

isHealthy()

isHealthy(): boolean;

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

Check if the scheduler is healthy and running.

Returns

boolean

true if running and connected

---

isPaused()

isPaused(name?): boolean;

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

Whether the local scheduler, or named worker, is effectively paused.

Parameters

Parameter	Type
name?	string

Returns

boolean

---

now()

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

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

Enqueue a job for immediate processing.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
name	string	Job type identifier
data	T	Job payload
options?	NowOptions	-

Returns

Promise<PersistedJob<T>>

The created job document

---

pause()

pause(name?): void;

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

Pause local executions, optionally for one fully qualified job name.

Parameters

Parameter	Type
name?	string

Returns

void

---

rescheduleJob()

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

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

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 | null>

The updated job, or null if not found

---

resume()

resume(name?): void;

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

Resume local executions without restarting the scheduler.

Parameters

Parameter	Type
name?	string

Returns

void

---

retryJob()

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

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

Retry a failed or cancelled job.

Parameters

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

Returns

Promise<PersistedJob | null>

The updated job, or null if not found

---

retryJobs()

retryJobs(filter): Promise<BulkOperationResult>;

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

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:125

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

---

setJobPriority()

setJobPriority(jobId, priority): Promise<PersistedJob | null>;

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

Change a pending Job’s priority, including subsequent recurring runs.

Parameters

Parameter	Type	Description
jobId	string	The ID of the pending Job
priority	number	The new signed safe integer priority

Returns

Promise<PersistedJob | null>

The updated Job, or null for a missing or invalid identifier