Skip to main content

Class: WorkflowBuilder

The recording builder passed to the defineWorkflow callback.

Constructors​

Constructor​

new WorkflowBuilder(autoIds): WorkflowBuilder

Parameters​

autoIds​

boolean

Returns​

WorkflowBuilder

Properties​

execution​

readonly execution: PredicateMethods

$execution: run metadata.


json​

readonly json: PredicateMethods

$json: the current item's JSON.


now​

readonly now: PredicateMethods

$now.


vars​

readonly vars: PredicateMethods

$vars: workflow variables.

Methods​

aggregate()​

aggregate(options): NodeRef

internal:aggregate.

Parameters​

options​

NodeOptions

Returns​

NodeRef


code()​

code(options): NodeRef

internal:code. The code is a string (args.code), so it round-trips byte for byte.

Parameters​

options​

NodeOptions

Returns​

NodeRef


codeWorkflow()​

codeWorkflow(fn, options?): NodeRef

internal:code-workflow: run a tier-2 function of this project as a durable child run. fn is a workflow() value (its export name is resolved when the bundle is collected) or an export name.

Parameters​

fn​

string | DurableWorkflow<never, unknown>

options?​

CodeWorkflowOptions

Returns​

NodeRef


compareDatasets()​

compareDatasets(options): CompareRef

internal:compare-datasets.

Parameters​

options​

NodeOptions

Returns​

CompareRef


connect()​

connect(from, to, options?): void

An edge added outside after, for example a loop's return edge.

Parameters​

from​

EdgeSource

to​

string | NodeRef<unknown>

options?​

EdgeOptions

Returns​

void


dataTable()​

dataTable(options): NodeRef

internal:datatable.

Parameters​

options​

NodeOptions

Returns​

NodeRef


dedupe()​

dedupe(options): NodeRef

internal:dedupe.

Parameters​

options​

NodeOptions

Returns​

NodeRef


durableReferences()​

durableReferences(): DurableRef[]

The wf.codeWorkflow calls that named a function.

Returns​

DurableRef[]


edgeOrderIs()​

edgeOrderIs(order): void

Put data.edges in this exact order. Each entry names one edge, by id or, for an edge without an id, by its position in declaration order; every edge appears once. The lifter emits this when a stored definition's edge order differs from the order the code declares its edges in.

Parameters​

order​

readonly (string | number)[]

Returns​

void


filter()​

filter(options): NodeRef

internal:filter.

Parameters​

options​

NodeOptions

Returns​

NodeRef


finish()​

finish(key, document): Tier1Recording

The recording, once the callback has returned.

Parameters​

key​

string

document​

JsonObject

Returns​

Tier1Recording


http()​

http(options): NodeRef

internal:http.

Parameters​

options​

NodeOptions

Returns​

NodeRef


if()​

if(options): IfRef

internal:if.

Parameters​

options​

IfOptions

Returns​

IfRef


limit()​

limit(options): NodeRef

internal:limit.

Parameters​

options​

NodeOptions

Returns​

NodeRef


log()​

log(options): NodeRef

internal:log.

Parameters​

options​

NodeOptions

Returns​

NodeRef


loop()​

loop(options, body?): LoopRef

internal:loop. With a body callback, the nodes the callback declares after batch form the loop body and the builder adds the return edge from the node the callback returns.

Parameters​

options​

LoopOptions

body?​

(batch) => EdgeSource

Returns​

LoopRef


merge()​

merge(options): NodeRef

internal:merge.

Parameters​

options​

MergeOptions

Returns​

NodeRef


noop()​

noop(options): NodeRef

internal:noop.

Parameters​

options​

NodeOptions

Returns​

NodeRef


note()​

note(content, options): void

A sticky note on the canvas.

Parameters​

content​

string

options​

NoteOptions

Returns​

void


ref()​

ref(id): NodeRef

A reference to a node by id, for nodes declared later in the source.

Parameters​

id​

string

Returns​

NodeRef


respondToWebhook()​

respondToWebhook(options): NodeRef

internal:respond-to-webhook.

Parameters​

options​

NodeOptions

Returns​

NodeRef


sendAndWait()​

sendAndWait(options): ApprovalRef

internal:send-and-wait.

Parameters​

options​

NodeOptions

Returns​

ApprovalRef


set()​

set(options): NodeRef

internal:set.

Parameters​

options​

NodeOptions

Returns​

NodeRef


sort()​

sort(options): NodeRef

internal:sort.

Parameters​

options​

NodeOptions

Returns​

NodeRef


splitOut()​

splitOut(options): NodeRef

internal:split-out.

Parameters​

options​

NodeOptions

Returns​

NodeRef


step()​

step<In, Out>(operation, options?): NodeRef<Out>

A store or internal node.

Type Parameters​

In​

In

Out​

Out

Parameters​

operation​

Operation<In, Out>

options?​

NodeOptions<NoInfer<In>>

Returns​

NodeRef<Out>


stopAndError()​

stopAndError(options): NodeRef

internal:error (stop and error).

Parameters​

options​

NodeOptions

Returns​

NodeRef


subworkflow()​

subworkflow(options): NodeRef

internal:subworkflow.

Parameters​

options​

SubworkflowOptions

Returns​

NodeRef


switch()​

switch(options): SwitchRef

internal:switch.

Parameters​

options​

SwitchOptions

Returns​

SwitchRef


transform()​

transform(options): NodeRef

internal:transform.

Parameters​

options​

NodeOptions

Returns​

NodeRef


trigger()​

trigger<In, Out>(operation, options?): NodeRef<Out>

A trigger node.

Type Parameters​

In​

In

Out​

Out

Parameters​

operation​

Operation<In, Out>

options?​

NodeOptions<NoInfer<In>>

Returns​

NodeRef<Out>


validate()​

validate(options): ValidateRef

internal:validate.

Parameters​

options​

NodeOptions

Returns​

ValidateRef


wait()​

wait(options): NodeRef

internal:wait.

Parameters​

options​

NodeOptions

Returns​

NodeRef


waitForSignal()​

waitForSignal(options): SignalWaitRef

internal:wait-for-signal (IR v2).

Parameters​

options​

WaitForSignalOptions

Returns​

SignalWaitRef