SquidMesh.Step behaviour (squid_mesh v0.1.0-alpha.7)

Copy Markdown View Source

Public contract for authoring native Squid Mesh workflow steps.

Native steps return Squid Mesh values and receive a SquidMesh.Step.Context. The runtime adapts them into the internal Jido execution path, so authors do not need to depend on Jido for the common workflow-step path.

Summary

Types

result()
schema()

Callbacks

run(input, context)

Types

result()

@type result() ::
  {:ok, map()}
  | {:ok, map(), keyword()}
  | {:error, term()}
  | {:retry, term()}
  | {:retry, term(), keyword()}

schema()

@type schema() :: keyword(keyword())

Callbacks

run(input, context)

@callback run(input :: map(), context :: SquidMesh.Step.Context.t()) :: result()