bunqueue
v2.8
API reference
all versions
·
guide
bunqueue
Guide
GitHub
Preparing search index...
client/workflow
WorkflowEmitter
Class WorkflowEmitter
Index
Constructors
constructor
Methods
emit
Signal
emit
Step
emit
Workflow
off
off
Any
on
on
Any
remove
All
Listeners
Constructors
constructor
new
WorkflowEmitter
()
:
WorkflowEmitter
Returns
WorkflowEmitter
Methods
emit
Signal
emitSignal
(
type
:
"signal:received"
|
"signal:timeout"
,
executionId
:
string
,
workflowName
:
string
,
event
:
string
,
payload
?:
unknown
,
)
:
void
Parameters
type
:
"signal:received"
|
"signal:timeout"
executionId
:
string
workflowName
:
string
event
:
string
Optional
payload
:
unknown
Returns
void
emit
Step
emitStep
(
type
:
|
"step:started"
|
"step:completed"
|
"step:failed"
|
"step:retry"
|
"compensation:started"
|
"compensation:completed"
|
"compensation:failed"
|
"compensation:skipped"
,
executionId
:
string
,
workflowName
:
string
,
stepName
:
string
,
extra
?:
Partial
<
Omit
<
StepEvent
,
"timestamp"
|
"type"
|
"executionId"
|
"workflowName"
|
"stepName"
,
>
,
>
,
)
:
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
Optional
extra
:
Partial
<
Omit
<
StepEvent
,
"timestamp"
|
"type"
|
"executionId"
|
"workflowName"
|
"stepName"
,
>
,
>
Returns
void
emit
Workflow
emitWorkflow
(
type
:
|
"workflow:started"
|
"workflow:completed"
|
"workflow:failed"
|
"workflow:compensating"
|
"workflow:waiting"
,
executionId
:
string
,
workflowName
:
string
,
state
:
ExecutionState
,
extra
?:
Partial
<
Omit
<
WorkflowLifecycleEvent
,
"timestamp"
|
"type"
|
"executionId"
|
"workflowName"
|
"state"
,
>
,
>
,
)
:
void
Parameters
type
:
|
"workflow:started"
|
"workflow:completed"
|
"workflow:failed"
|
"workflow:compensating"
|
"workflow:waiting"
executionId
:
string
workflowName
:
string
state
:
ExecutionState
Optional
extra
:
Partial
<
Omit
<
WorkflowLifecycleEvent
,
"timestamp"
|
"type"
|
"executionId"
|
"workflowName"
|
"state"
,
>
,
>
Returns
void
off
off
(
type
:
WorkflowEventType
,
listener
:
WorkflowEventListener
)
:
this
Parameters
type
:
WorkflowEventType
listener
:
WorkflowEventListener
Returns
this
off
Any
offAny
(
listener
:
WorkflowEventListener
)
:
this
Parameters
listener
:
WorkflowEventListener
Returns
this
on
on
(
type
:
WorkflowEventType
,
listener
:
WorkflowEventListener
)
:
this
Parameters
type
:
WorkflowEventType
listener
:
WorkflowEventListener
Returns
this
on
Any
onAny
(
listener
:
WorkflowEventListener
)
:
this
Parameters
listener
:
WorkflowEventListener
Returns
this
remove
All
Listeners
removeAllListeners
()
:
void
Returns
void
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
emit
Signal
emit
Step
emit
Workflow
off
off
Any
on
on
Any
remove
All
Listeners
Guide
GitHub
bunqueue
Loading...