DataStarSSE.ServerSentEventGenerator (Datastar-SSE v0.1.0)
View SourceThe ServerSentEventGenerator
module.
Summary
Functions
Sends a DataStar execute script event
Setups of connection to response with Server-Sent Events
Sends a DataStar patch elements event
Sends a DataStar patch signals event
Parses DataStar signals from Plug.Conn as JSON
Functions
Sends a DataStar execute script event
conn - Plug.Conn script - String opts - Optional Datastar execute script event options
returns Plug.Conn
Examples
DataStarSSE.ServerSentEventGenerator.execute_script(
conn,
"console.log('Hello World!')",
auto_remove: true,
event_id: 123
)
Setups of connection to response with Server-Sent Events
returns Plug.Conn
Sends a DataStar patch elements event
conn - Plug.Conn elements - String opts - Optional Datastar patch element event options
returns Plug.Conn
Examples
DataStarSSE.ServerSentEventGenerator.patch_elements(
conn,
"<div id="welcome">Hello World!</div>",
mode: "outer",
use_view_transition: false,
event_id: 123
)
Sends a DataStar patch signals event
conn - Plug.Conn signals - String opts - Optional Datastar patch element event options
returns Plug.Conn
Examples
DataStarSSE.ServerSentEventGenerator.patch_signals(
conn,
Jason.encode(%{"signal" => "Hello World"}),
only_if_missing: true,
event_id: 123
)
Parses DataStar signals from Plug.Conn as JSON
conn - Plug.Conn script - String opts - Optional Datastar execute script event options
returns {:ok, conn, signals} or {:error, reason}
Examples
DataStarSSE.ServerSentEventGenerator.read_signals(conn)