Incant.ActionResult (incant v0.1.0)

Copy Markdown

Semantic results returned by Incant actions.

Action callbacks can return these structs directly or use shorthand returns such as :ok, "Done", {:ok, "Done"}, or {:error, "Nope"}. Live adapters decide how to apply each result.

Summary

Types

t()

Functions

download(id, opts \\ [])
error(result)
job(id, opts \\ [])
navigate(to, opts \\ [])
normalize(result, opts \\ [])
open_surface(surface, opts \\ [])
refresh(targets \\ [:surface])
reveal(value, opts \\ [])
toast(message, level \\ :info)

Types

t()

@type t() ::
  Incant.ActionResult.Toast.t()
  | Incant.ActionResult.Error.t()
  | Incant.ActionResult.Refresh.t()
  | Incant.ActionResult.Navigate.t()
  | Incant.ActionResult.Download.t()
  | Incant.ActionResult.Job.t()
  | Incant.ActionResult.OpenSurface.t()
  | Incant.ActionResult.Reveal.t()

Functions

download(id, opts \\ [])

error(result)

job(id, opts \\ [])

normalize(result, opts \\ [])

open_surface(surface, opts \\ [])

refresh(targets \\ [:surface])

reveal(value, opts \\ [])

toast(message, level \\ :info)