View Source Rephex.Api.LiveViewApi behaviour (rephex v0.1.1)

The behaviour for the LiveView sub-effect.

Summary

Callbacks

Link to this callback

cancel_async(socket, name, reason)

View Source
@callback cancel_async(
  socket :: Phoenix.LiveView.Socket.t(),
  name :: term(),
  reason :: term()
) :: Phoenix.LiveView.Socket.t()
Link to this callback

start_async(socket, name, func)

View Source
@callback start_async(
  socket :: Phoenix.LiveView.Socket.t(),
  name :: term(),
  func :: (-> term())
) :: Phoenix.LiveView.Socket.t()

Functions

Link to this function

cancel_async(socket, name, reason \\ {:shutdown, :cancel})

View Source

Callback implementation for Rephex.Api.LiveViewApi.cancel_async/3.

Link to this function

start_async(socket, name, fun)

View Source

Callback implementation for Rephex.Api.LiveViewApi.start_async/3.