SquidMesh.Tools.Adapter behaviour (squid_mesh v0.1.0-alpha.3)

Copy Markdown View Source

Behaviour for Squid Mesh tool adapters.

Adapters receive a request map and a workflow context map, then return either a normalized tool result or a normalized tool error.

Summary

Types

context()

@type context() :: map()

request()

@type request() :: map()

Callbacks

invoke(request, context, keyword)

@callback invoke(request(), context(), keyword()) ::
  {:ok, SquidMesh.Tools.Result.t()} | {:error, SquidMesh.Tools.Error.t()}