basalt / queue/src / JobDefinition
Interface: JobDefinition<T>
Defined in: queue/src/job.ts:52
Type Parameters
T
T = unknown
Properties
attempts
> readonly attempts: number
Defined in: queue/src/job.ts:56
backoff?
> readonly optional backoff?: JobBackoff
Defined in: queue/src/job.ts:57
name
> readonly name: string
Defined in: queue/src/job.ts:53
queue
> readonly queue: string
Defined in: queue/src/job.ts:55
removeOnComplete?
> readonly optional removeOnComplete?: JobRetention
Defined in: queue/src/job.ts:59
Retention for completed jobs. Overrides the queuePlugin default.
removeOnFail?
> readonly optional removeOnFail?: JobRetention
Defined in: queue/src/job.ts:61
Retention for failed jobs. Overrides the queuePlugin default.
schema?
> readonly optional schema?: JobSchema<T>
Defined in: queue/src/job.ts:54
Methods
dispatch()
> dispatch(payload, options?): Promise<void>
Defined in: queue/src/job.ts:64
Enqueues the job — available after registration in a QueueManager.
Parameters
payload
T
options?
Returns
Promise<void>
handle()
> handle(payload): void | Promise<void>
Defined in: queue/src/job.ts:62
Parameters
payload
T
Returns
void | Promise<void>