bunqueue v2.8 API referenceall versions · guide
bunqueue
    Preparing search index...

    Class WorkflowEmitter

    Index
    • Parameters

      • type: "signal:received" | "signal:timeout"
      • executionId: string
      • workflowName: string
      • event: string
      • Optionalpayload: unknown

      Returns void

    • Parameters

      • type:
            | "step:started"
            | "step:completed"
            | "step:failed"
            | "step:retry"
            | "compensation:started"
            | "compensation:completed"
            | "compensation:failed"
            | "compensation:skipped"
      • executionId: string
      • workflowName: string
      • stepName: string
      • Optionalextra: Partial<
            Omit<
                StepEvent,
                "timestamp"
                | "type"
                | "executionId"
                | "workflowName"
                | "stepName",
            >,
        >

      Returns void

    • Parameters

      • type:
            | "workflow:started"
            | "workflow:completed"
            | "workflow:failed"
            | "workflow:compensating"
            | "workflow:waiting"
      • executionId: string
      • workflowName: string
      • state: ExecutionState
      • Optionalextra: Partial<
            Omit<
                WorkflowLifecycleEvent,
                "timestamp"
                | "type"
                | "executionId"
                | "workflowName"
                | "state",
            >,
        >

      Returns void