Documentation

Documentation / @zerotal/notifications / BroadcastNotificationJob

Class: BroadcastNotificationJob

Defined in: notifications/src/BroadcastNotificationJob.ts:12

Delivers one broadcast notification from a queue.

Dispatched only when a BroadcastMessage names a queue or connection via onQueue() / onConnection(); an unrouted broadcast goes out inline, since the whole point of the channel is immediacy. Its payload is the resolved wire data, so it round-trips through a persistent driver without needing the notification class.

Extends

• Job

Constructors

Constructor

new BroadcastNotificationJob(_channel?, _event?, _data?, queue?): BroadcastNotificationJob

Defined in: notifications/src/BroadcastNotificationJob.ts:15

Parameters

_channel?

string = ""

_event?

string = ""

_data?

Record<string, unknown> = {}

queue?

string = "broadcast"

Returns

BroadcastNotificationJob

Overrides

Job.constructor

Properties

queue

readonly queue: string

Defined in: notifications/src/BroadcastNotificationJob.ts:13

Queue name — override in subclass to route to specific queues

Overrides

Job.queue

maxAttempts

readonly maxAttempts: number = 3

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

Max retry attempts before moving to failed queue

Inherited from

Job.maxAttempts

retryDelay

readonly retryDelay: number = 1000

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

Milliseconds to wait between retry attempts

Inherited from

Job.retryDelay

batchId

batchId: string | undefined = undefined

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

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

Inherited from

Job.batchId

_chain

_chain: SerializedJob[] | undefined = undefined

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

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

Inherited from

Job._chain

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

Inherited from

Job.className

Methods

payload()

payload(): Record<string, unknown>

Defined in: notifications/src/BroadcastNotificationJob.ts:25

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

Returns

Record<string, unknown>

Overrides

Job.payload

fromPayload()

static fromPayload(data): BroadcastNotificationJob

Defined in: notifications/src/BroadcastNotificationJob.ts:34

Parameters

data

Record<string, unknown>

Returns

BroadcastNotificationJob

handle()

handle(): Promise<void>

Defined in: notifications/src/BroadcastNotificationJob.ts:43

The job's work — implement this in every subclass

Returns

Promise<void>

Overrides

Job.handle