Jidoka.Agent.Spec.Controls.Output (Jidoka v0.9.0)

Copy Markdown View Source

Control attached to the final output boundary.

Summary

Functions

Normalizes an existing output control, keyword list, or map.

Builds an output control from keyword or map attributes.

Builds an output control and raises if the attributes are invalid.

Returns the Zoi schema for an output control.

Types

t()

@type t() :: %Jidoka.Agent.Spec.Controls.Output{control: atom(), metadata: map()}

Functions

from_input(output)

@spec from_input(t() | keyword() | map()) :: {:ok, t()} | {:error, term()}

Normalizes an existing output control, keyword list, or map.

new(attrs)

@spec new(keyword() | map()) :: {:ok, t()} | {:error, term()}

Builds an output control from keyword or map attributes.

new!(attrs)

@spec new!(keyword() | map()) :: t()

Builds an output control and raises if the attributes are invalid.

schema()

@spec schema() :: Zoi.schema()

Returns the Zoi schema for an output control.