Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/rulvar / defineWorkflow

Function: defineWorkflow()

ts
function defineWorkflow<A, R, P>(meta, body): Workflow<A, R>;

Defined in: packages/core/dist/index.d.ts

Type Parameters

Type ParameterDefault type
A-
R-
P extends ErrorPolicy"strict"

Parameters

ParameterType
meta{ args?: SchemaSpec&lt;A&gt;; effort?: Effort; errorPolicy?: P; model?: ModelSpec; name: string; routing?: Partial&lt;Record&lt;InvocationRole, ModelSpec&gt;&gt;; }
meta.args?SchemaSpec&lt;A&gt;
meta.effort?Effort
meta.errorPolicy?P
meta.model?ModelSpec
meta.namestring
meta.routing?Partial&lt;Record&lt;InvocationRole, ModelSpec&gt;&gt;
body(ctx, args) => Promise&lt;R&gt;

Returns

Workflow&lt;A, R&gt;