Alva.Resource.Signal (Alva v0.1.0)

Copy Markdown View Source

Represents a single signal definition within an Alva.Resource block.

This struct is the target of the Spark DSL for the signal entity. It holds the parsed configuration linking a frontend PubSub subscription request to an underlying Ash PubSub occurrence, including authorization requirements via authorize_with.

Summary

Types

t()

A parsed signal configuration linking a PubSub occurrence to a frontend signal.

Types

t()

(since 0.1.0) 
@type t() :: %Alva.Resource.Signal{
  __spark_metadata__: term(),
  authorize_with: atom(),
  expose_metadata: [atom()],
  key: atom(),
  name: String.t(),
  on: [atom() | String.t()]
}

A parsed signal configuration linking a PubSub occurrence to a frontend signal.