Documentation / @zerotal/queue / index / Job

Abstract Class: Job

Defined in: queue/src/Job.ts:3

Extended by

Constructors

Constructor

new Job(): Job

Returns

Job

Properties

queue

readonly queue: string = "default"

Defined in: queue/src/Job.ts:5

Queue name — override in subclass to route to specific queues

maxAttempts

readonly maxAttempts: number = 3

Defined in: queue/src/Job.ts:8

Max retry attempts before moving to failed queue

retryDelay

readonly retryDelay: number = 1000

Defined in: queue/src/Job.ts:11

Milliseconds to wait between retry attempts

batchId

batchId: string | undefined = undefined

Defined in: queue/src/Job.ts:14

Set by Bus.batch() — tracks which batch this job belongs to.

_chain

_chain: SerializedJob[] | undefined = undefined

Defined in: queue/src/Job.ts:17

Set by Bus.chain() — remaining jobs to dispatch after this one succeeds.

Accessors

className

Get Signature

get className(): string

Defined in: queue/src/Job.ts:34

The class name used as the serialization key. Must match what JobRegistry.register() stores.

Returns

string

Methods

handle()

abstract handle(): Promise<void>

Defined in: queue/src/Job.ts:20

The job's work — implement this in every subclass

Returns

Promise<void>

payload()

payload(): Record<string, unknown>

Defined in: queue/src/Job.ts:26

Serialize job state to a plain object for storage. Override in subclasses that have constructor arguments.

Returns

Record<string, unknown>