Interface

TimelineCommandResult

Consistent result returned by React hook command APIs.

Signature

Type Definition
Interface TimelineCommandResult

Type parameters

NameConstraintDefaultDescription
ValueNonevoidOptional successful command payload.

Properties

NameSignatureDescription
cause?cause?: ErrorOriginal error that caused the failure, when available.
message?message?: stringOptional human-readable failure detail for product UI and diagnostics.
okok: booleanWhether the command was applied.
reason?reason?: TimelineCommandFailureReasonReason the command was not applied.
value?value?: ValueOptional successful command payload.