ScheduleOptions

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

Options for scheduling a recurring job.

Example

await monque. schedule('0 * * * *', 'hourly-cleanup', { dir: '/tmp' }, {
  uniqueKey: 'hourly-cleanup-job',
});

Extends

• JobWriteOptions

Properties

priority?

optional priority?: number;

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

Signed safe integer retained across recurring runs. Defaults to 0.

---

session?

optional session?: ClientSession;

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

Session from the MongoClient used by Monque. The caller owns its lifetime, transaction, and commit. In a transaction, jobs become visible to workers after commit.

Inherited from

JobWriteOptions.session

---

timezone?

optional timezone?: string;

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

IANA timezone for the recurring schedule, for example Europe/Berlin or UTC. When omitted, cron evaluation uses the server’s local timezone.

---

uniqueKey?

optional uniqueKey?: string;

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

Deduplication key. If a job with this key is already pending or processing, the schedule operation will not create a duplicate.