Skip to content
1 min read · 152 words

Interface: DispatchEndEvent

Defined in: lib/types/dispatch_runner.ts:293

Payload fired when a dispatch ends — successfully, by error, or by abort.

Properties

PropertyTypeDescriptionDefined in
dispatchIdstringStable identifier for this dispatch.lib/types/dispatch_runner.ts:295
durationMsnumberDuration in milliseconds.lib/types/dispatch_runner.ts:307
endedAtDateTimeWhen the dispatch ended.lib/types/dispatch_runner.ts:305
error?ErrorThe error stored by ctx.nack(error), or undefined for ack / aborted.lib/types/dispatch_runner.ts:299
iterationsnumberTotal iterations that ran during this dispatch.lib/types/dispatch_runner.ts:301
startedAtDateTimeWhen the dispatch began.lib/types/dispatch_runner.ts:303
status"ack" | "nack" | "aborted"How the dispatch settled.lib/types/dispatch_runner.ts:297