Function: enqueueJob()

enqueueJob<Path>>>>>(jobPath, params, options?): Promise<JobRecord>>>>>

Enqueue a pending job by its .job.ts path-derived identifier.

The jobs table is initialized automatically. When idempotencyKey is supplied and a matching row already exists, the existing row is returned unchanged.

Type Parameters

Path

Path extends FaasJobPaths

Parameters

jobPath

Path

The job path identifier derived from the .job.ts file location.

params

FaasJobParams<Path>

The parameters to pass to the job handler.

options?

EnqueueJobOptions = {}

Enqueue options including client, queue, priority, run time, and idempotency.

Returns

Promise<JobRecord>

The persisted job record.

Throws

When queue, job path, priority, max attempts, or database writes are invalid.

Examples

await enqueueJob('features/users/jobs/sync', { userId: 'u_123' })

await enqueueJob(
  'features/reports/jobs/daily',
  {},
  {
    queue: 'reports',
    priority: 10,
    idempotencyKey: 'report-2025-01-01',
  },
)

await client.transaction(async (trx) => {
  await updateBusinessState(trx)
  await enqueueJob(
    'features/users/jobs/sync',
    { userId: 'u_123' },
    {
      client: trx,
    },
  )
})