Interface: RoutableEngine {#interface-routableengine}

Minimal engine surface required by the HTTP server layer.

Methods {#methods}

countByState() {#countbystate}

countByState(state): number

Parameters {#countbystate-parameters}

state {#countbystate-state}

ProcessState

Returns {#countbystate-returns}

number

emit() {#emit}

emit(event, payload, opts?): Run[]

Parameters {#emit-parameters}

event {#emit-event}

string

payload {#emit-payload}

unknown

opts? {#emit-opts}

idempotencyKey? {#emit-idempotencykey}

string

Returns {#emit-returns}

Run[]

getChain() {#getchain}

getChain(runId): Run[]

Parameters {#getchain-parameters}

runId {#getchain-runid}

string

Returns {#getchain-returns}

Run[]

getCompleted() {#getcompleted}

getCompleted(): Run[]

Returns {#getcompleted-returns}

Run[]

getEffects() {#geteffects}

getEffects(runId): EffectRecord[]

Parameters {#geteffects-parameters}

runId {#geteffects-runid}

string

Returns {#geteffects-returns}

EffectRecord[]

getErrored() {#geterrored}

getErrored(): Run[]

Returns {#geterrored-returns}

Run[]

getGraph() {#getgraph}

getGraph(): EventGraph

Returns {#getgraph-returns}

EventGraph

getIdle() {#getidle}

getIdle(): Run[]

Returns {#getidle-returns}

Run[]

getMetrics() {#getmetrics}

getMetrics(): EngineMetrics

Returns {#getmetrics-returns}

EngineMetrics

getObservability() {#getobservability}

getObservability(query?): EngineObservabilityReport

Parameters {#getobservability-parameters}

query? {#getobservability-query}

EngineObservabilityQuery

Returns {#getobservability-returns}

EngineObservabilityReport

getProcesses() {#getprocesses}

getProcesses(): ProcessDefinition[]

Returns {#getprocesses-returns}

ProcessDefinition[]

getRun() {#getrun}

getRun(id): Run | null

Parameters {#getrun-parameters}

id {#getrun-id}

string

Returns {#getrun-returns}

Run | null

getRunning() {#getrunning}

getRunning(): Run[]

Returns {#getrunning-returns}

Run[]

getRunsByStatusPaginated() {#getrunsbystatuspaginated}

getRunsByStatusPaginated(status, limit, offset, opts?): object

Parameters {#getrunsbystatuspaginated-parameters}

status {#getrunsbystatuspaginated-status}

RunStatus

limit {#getrunsbystatuspaginated-limit}

number

offset {#getrunsbystatuspaginated-offset}

number

opts? {#getrunsbystatuspaginated-opts}

order? {#getrunsbystatuspaginated-order}

"asc" | "desc"

root? {#getrunsbystatuspaginated-root}

boolean

Returns {#getrunsbystatuspaginated-returns}

object

runs {#getrunsbystatuspaginated-runs}

runs: Run[]

total {#getrunsbystatuspaginated-total}

total: number

getRunsPaginated() {#getrunspaginated}

getRunsPaginated(state, limit, offset, opts?): object

Parameters {#getrunspaginated-parameters}

state {#getrunspaginated-state}

ProcessState | null

limit {#getrunspaginated-limit}

number

offset {#getrunspaginated-offset}

number

opts? {#getrunspaginated-opts}

order? {#getrunspaginated-order}

"asc" | "desc"

root? {#getrunspaginated-root}

boolean

Returns {#getrunspaginated-returns}

object

runs {#getrunspaginated-runs}

runs: Run[]

total {#getrunspaginated-total}

total: number

requeueDead() {#requeuedead}

requeueDead(runId): Run

Parameters {#requeuedead-parameters}

runId {#requeuedead-runid}

string

Returns {#requeuedead-returns}

Run

resume() {#resume}

resume(runId, payload?): Run[]

Parameters {#resume-parameters}

runId {#resume-runid}

string

payload? {#resume-payload}

unknown

Returns {#resume-returns}

Run[]

retryRun() {#retryrun}

retryRun(runId): Run

Parameters {#retryrun-parameters}

runId {#retryrun-runid}

string

Returns {#retryrun-returns}

Run

subscribeEvents() {#subscribeevents}

subscribeEvents(listener): () => void

Parameters {#subscribeevents-parameters}

listener {#subscribeevents-listener}

(event) => void

Returns {#subscribeevents-returns}

(): void

Returns {#subscribeevents-returns-1}

void