Jido.Messaging.CommandResult (Jido Messaging v1.1.0)

Copy Markdown View Source

Result returned by eventful Jido.Messaging command APIs.

Low-level persistence functions return records directly. Command APIs return the committed record plus the Jido.Signal events emitted for that command so apps can test, inspect, or bridge realtime UI behavior without scraping logs.

Summary

Types

t()
t(record)

Functions

new(record, signals \\ [], metadata \\ %{})

Builds a command result from the committed record and emitted signals.

Types

t()

@type t() :: t(term())

t(record)

@type t(record) :: %Jido.Messaging.CommandResult{
  metadata: map(),
  record: record,
  signals: [Jido.Signal.t()]
}

Functions

new(record, signals \\ [], metadata \\ %{})

@spec new(term(), [Jido.Signal.t()], map()) :: t()

Builds a command result from the committed record and emitted signals.