Function

timelineCommandFail

Creates a failed timeline command result.

Signature

Type Definition
timelineCommandFail(reason: TimelineCommandFailureReason, message?: string, cause?: Error): TimelineCommandResult<Value>

Type parameters

NameConstraintDefaultDescription
ValueNonevoidNo type parameter summary yet.

Parameters

NameTypeDescription
reasonTimelineCommandFailureReasonMachine-readable failure reason.
messagestringOptional human-readable failure detail.
causeErrorOptional original error that caused the failure.

Returns

Failed command result.