LivePanels.Canvas.Command (livepanels v0.1.0)

Copy Markdown View Source

Internal command dispatch and input normalization used by app-facing canvas command modules.

Socket targets dispatch through the mounted runtime command runner. Transaction targets append commands to the transaction preview state, which lets derived commands read the result of earlier staged commands before the transaction commits.

Summary

Types

command()
result()
target()

Types

command()

@type command() :: tuple()

result()

@type result() ::
  {:ok, target(), LivePanels.Canvas.Command.Meta.t()}
  | {:error, term(), target(), LivePanels.Canvas.Command.Meta.t()}

target()

@type target() :: Phoenix.LiveView.Socket.t() | LivePanels.Canvas.Transaction.t()