Skip to main content

Interface: ExpectedEvent

One expected event: its type and, optionally, a subset of its payload.

Properties​

payload?​

optional payload?: Record<string, unknown>


type​

type: "WORKFLOW_STARTED" | "WORKFLOW_TASK_SCHEDULED" | "WORKFLOW_TASK_STARTED" | "WORKFLOW_TASK_COMPLETED" | "WORKFLOW_TASK_FAILED" | "WORKFLOW_TASK_TIMED_OUT" | "ACTIVITY_SCHEDULED" | "ACTIVITY_STARTED" | "ACTIVITY_HEARTBEAT" | "ACTIVITY_COMPLETED" | "ACTIVITY_FAILED" | "ACTIVITY_TIMED_OUT" | "ACTIVITY_CANCEL_REQUESTED" | "ACTIVITY_CANCELLED" | "ACTIVITY_PAUSED" | "ACTIVITY_UNPAUSED" | "ACTIVITY_RESET" | "ACTIVITY_OPTIONS_UPDATED" | "TIMER_STARTED" | "TIMER_FIRED" | "TIMER_CANCELLED" | "SIGNAL_RECEIVED" | "UPDATE_ADMITTED" | "UPDATE_ACCEPTED" | "UPDATE_COMPLETED" | "CHILD_RUN_INITIATED" | "CHILD_RUN_STARTED" | "CHILD_RUN_COMPLETED" | "CHILD_RUN_FAILED" | "CHILD_RUN_CANCELLED" | "CHILD_RUN_TERMINATED" | "CHILD_RUN_TIMED_OUT" | "EXTERNAL_RUN_CANCEL_REQUESTED" | "EXTERNAL_RUN_CANCEL_RESOLVED" | "EXTERNAL_RUN_SIGNALED" | "SIDE_EFFECT_RECORDED" | "LOCAL_ACTIVITY_COMPLETED" | "LOCAL_ACTIVITY_FAILED" | "SEARCH_ATTRIBUTES_UPSERTED" | "CONTEXT_UPSERTED" | "MARKER_RECORDED" | "WORKFLOW_CANCEL_REQUESTED" | "WORKFLOW_RESET" | "VERSIONING_OVERRIDE_SET" | "WORKFLOW_COMPLETED" | "WORKFLOW_FAILED" | "WORKFLOW_CANCELLED" | "WORKFLOW_TERMINATED" | "WORKFLOW_TIMED_OUT" | "WORKFLOW_CONTINUED_AS_NEW"