CommandProcessorEvents
CommandProcessorEvents =
object
Defined in: packages/client/src/lib/command-processor/command-processor.ts:39
Event map for CommandProcessor lifecycle events.
Properties
Section titled “Properties”action_error
Section titled “action_error”action_error:
object
Defined in: packages/client/src/lib/command-processor/command-processor.ts:82
Fired when one or more actions in a batch fail or are skipped.
action
Section titled “action”action:
ActionName
The action that failed.
error:
Error|undefined
The error the action failed with, or undefined if it was skipped.
instanceId
Section titled “instanceId”instanceId:
InstanceId
The Instance the failing action targeted.
timestamp
Section titled “timestamp”timestamp:
number
performance.now() reading taken when the error was reported.
batch_abandoned
Section titled “batch_abandoned”batch_abandoned:
object
Defined in: packages/client/src/lib/command-processor/command-processor.ts:71
Fired when a command in a multi-command batch throws and the rest of
that batch is abandoned. failed is the command that threw (already
reported through processing_error); abandoned are the commands after
it that never ran.
abandoned
Section titled “abandoned”abandoned: readonly
Command[]
The commands after failed that were never processed.
error:
Error
The error failed threw.
failed
Section titled “failed”failed:
Command
The command that threw and stopped the batch.
timestamp
Section titled “timestamp”timestamp:
number
performance.now() reading taken when the batch was abandoned.
command_complete
Section titled “command_complete”command_complete:
object
Defined in: packages/client/src/lib/command-processor/command-processor.ts:48
Fired when a command finishes processing, whether it succeeded or threw.
command
Section titled “command”command:
Command
The command that finished processing.
duration
Section titled “duration”duration:
number
Milliseconds elapsed between command_start and this event.
timestamp
Section titled “timestamp”timestamp:
number
performance.now() reading taken when the command completed.
command_start
Section titled “command_start”command_start:
object
Defined in: packages/client/src/lib/command-processor/command-processor.ts:41
Fired when a command begins processing.
command
Section titled “command”command:
Command
The command that began processing.
timestamp
Section titled “timestamp”timestamp:
number
performance.now() reading taken when the command started.
processing_error
Section titled “processing_error”processing_error:
object
Defined in: packages/client/src/lib/command-processor/command-processor.ts:57
Fired when a command throws while processing.
command
Section titled “command”command:
Command
The command that threw.
error:
Error
The error the command threw.
timestamp
Section titled “timestamp”timestamp:
number
performance.now() reading taken when the error was reported.